<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>modbus_tk.modbus_tcp</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://code.google.com/p/modbus-tk/">Modbus Test Kit</a></th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="modbus_tk-module.html">Package&nbsp;modbus_tk</a> ::
        Module&nbsp;modbus_tcp
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="modbus_tk.modbus_tcp-pysrc.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<h1 class="epydoc">Source Code for <a href="modbus_tk.modbus_tcp-module.html">Module modbus_tk.modbus_tcp</a></h1>
<pre class="py-src">
<a name="L1"></a><tt class="py-lineno">  1</tt>  <tt class="py-line"><tt class="py-comment">#!/usr/bin/env python</tt> </tt>
<a name="L2"></a><tt class="py-lineno">  2</tt>  <tt class="py-line"><tt class="py-comment"># -*- coding: utf-8 -*-</tt> </tt>
<a name="L3"></a><tt class="py-lineno">  3</tt>  <tt class="py-line"><tt class="py-docstring">"""</tt> </tt>
<a name="L4"></a><tt class="py-lineno">  4</tt>  <tt class="py-line"><tt class="py-docstring"> Modbus TestKit: Implementation of Modbus protocol in python</tt> </tt>
<a name="L5"></a><tt class="py-lineno">  5</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L6"></a><tt class="py-lineno">  6</tt>  <tt class="py-line"><tt class="py-docstring"> (C)2009 - Luc Jean - luc.jean@gmail.com</tt> </tt>
<a name="L7"></a><tt class="py-lineno">  7</tt>  <tt class="py-line"><tt class="py-docstring"> (C)2009 - Apidev - http://www.apidev.fr</tt> </tt>
<a name="L8"></a><tt class="py-lineno">  8</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L9"></a><tt class="py-lineno">  9</tt>  <tt class="py-line"><tt class="py-docstring"> This is distributed under GNU LGPL license, see license.txt</tt> </tt>
<a name="L10"></a><tt class="py-lineno"> 10</tt>  <tt class="py-line"><tt class="py-docstring">"""</tt> </tt>
<a name="L11"></a><tt class="py-lineno"> 11</tt>  <tt class="py-line"> </tt>
<a name="L12"></a><tt class="py-lineno"> 12</tt>  <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-0" class="py-name" targets="Module modbus_tk.modbus=modbus_tk.modbus-module.html"><a title="modbus_tk.modbus" class="py-name" href="#" onclick="return doclink('link-0', 'modbus', 'link-0');">modbus</a></tt> <tt class="py-keyword">import</tt> <tt class="py-op">*</tt> </tt>
<a name="L13"></a><tt class="py-lineno"> 13</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">socket</tt> </tt>
<a name="L14"></a><tt class="py-lineno"> 14</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">select</tt> </tt>
<a name="L15"></a><tt class="py-lineno"> 15</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">logging</tt> </tt>
<a name="L16"></a><tt class="py-lineno"> 16</tt>  <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-1" class="py-name" targets="Module modbus_tk.hooks=modbus_tk.hooks-module.html"><a title="modbus_tk.hooks" class="py-name" href="#" onclick="return doclink('link-1', 'hooks', 'link-1');">hooks</a></tt> <tt class="py-keyword">import</tt> <tt id="link-2" class="py-name" targets="Function modbus_tk.hooks.call_hooks()=modbus_tk.hooks-module.html#call_hooks"><a title="modbus_tk.hooks.call_hooks" class="py-name" href="#" onclick="return doclink('link-2', 'call_hooks', 'link-2');">call_hooks</a></tt> </tt>
<a name="L17"></a><tt class="py-lineno"> 17</tt>  <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-3" class="py-name" targets="Module modbus_tk.utils=modbus_tk.utils-module.html"><a title="modbus_tk.utils" class="py-name" href="#" onclick="return doclink('link-3', 'utils', 'link-3');">utils</a></tt> <tt class="py-keyword">import</tt> <tt id="link-4" class="py-name" targets="Function modbus_tk.utils.threadsafe_function()=modbus_tk.utils-module.html#threadsafe_function"><a title="modbus_tk.utils.threadsafe_function" class="py-name" href="#" onclick="return doclink('link-4', 'threadsafe_function', 'link-4');">threadsafe_function</a></tt> </tt>
<a name="L18"></a><tt class="py-lineno"> 18</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">sys</tt> </tt>
<a name="ModbusInvalidMbapError"></a><div id="ModbusInvalidMbapError-def"><a name="L19"></a><tt class="py-lineno"> 19</tt>  <tt class="py-line"> </tt>
<a name="L20"></a><tt class="py-lineno"> 20</tt>  <tt class="py-line"><tt class="py-comment">#-------------------------------------------------------------------------------</tt> </tt>
<a name="L21"></a><tt class="py-lineno"> 21</tt> <a class="py-toggle" href="#" id="ModbusInvalidMbapError-toggle" onclick="return toggle('ModbusInvalidMbapError');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="modbus_tk.modbus_tcp.ModbusInvalidMbapError-class.html">ModbusInvalidMbapError</a><tt class="py-op">(</tt><tt class="py-base-class">Exception</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ModbusInvalidMbapError-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="ModbusInvalidMbapError-expanded"><a name="L22"></a><tt class="py-lineno"> 22</tt>  <tt class="py-line">    <tt class="py-docstring">"""Exception raised when the modbus TCP header doesn't correspond to what is expected"""</tt> </tt>
<a name="ModbusInvalidMbapError.__init__"></a><div id="ModbusInvalidMbapError.__init__-def"><a name="L23"></a><tt class="py-lineno"> 23</tt> <a class="py-toggle" href="#" id="ModbusInvalidMbapError.__init__-toggle" onclick="return toggle('ModbusInvalidMbapError.__init__');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus_tcp.ModbusInvalidMbapError-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">value</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ModbusInvalidMbapError.__init__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="ModbusInvalidMbapError.__init__-expanded"><a name="L24"></a><tt class="py-lineno"> 24</tt>  <tt class="py-line">        <tt class="py-name">Exception</tt><tt class="py-op">.</tt><tt id="link-5" class="py-name" targets="Method modbus_tk.modbus.Databank.__init__()=modbus_tk.modbus.Databank-class.html#__init__,Method modbus_tk.modbus.Master.__init__()=modbus_tk.modbus.Master-class.html#__init__,Method modbus_tk.modbus.ModbusBlock.__init__()=modbus_tk.modbus.ModbusBlock-class.html#__init__,Method modbus_tk.modbus.ModbusError.__init__()=modbus_tk.modbus.ModbusError-class.html#__init__,Method modbus_tk.modbus.Query.__init__()=modbus_tk.modbus.Query-class.html#__init__,Method modbus_tk.modbus.Server.__init__()=modbus_tk.modbus.Server-class.html#__init__,Method modbus_tk.modbus.Slave.__init__()=modbus_tk.modbus.Slave-class.html#__init__,Method modbus_tk.modbus_rtu.RtuMaster.__init__()=modbus_tk.modbus_rtu.RtuMaster-class.html#__init__,Method modbus_tk.modbus_rtu.RtuQuery.__init__()=modbus_tk.modbus_rtu.RtuQuery-class.html#__init__,Method modbus_tk.modbus_rtu.RtuServer.__init__()=modbus_tk.modbus_rtu.RtuServer-class.html#__init__,Method modbus_tk.modbus_tcp.ModbusInvalidMbapError.__init__()=modbus_tk.modbus_tcp.ModbusInvalidMbapError-class.html#__init__,Method modbus_tk.modbus_tcp.TcpMaster.__init__()=modbus_tk.modbus_tcp.TcpMaster-class.html#__init__,Method modbus_tk.modbus_tcp.TcpMbap.__init__()=modbus_tk.modbus_tcp.TcpMbap-class.html#__init__,Method modbus_tk.modbus_tcp.TcpQuery.__init__()=modbus_tk.modbus_tcp.TcpQuery-class.html#__init__,Method modbus_tk.modbus_tcp.TcpServer.__init__()=modbus_tk.modbus_tcp.TcpServer-class.html#__init__,Method modbus_tk.simulator.CompositeServer.__init__()=modbus_tk.simulator.CompositeServer-class.html#__init__,Method modbus_tk.simulator.ConsoleInterface.__init__()=modbus_tk.simulator.ConsoleInterface-class.html#__init__,Method modbus_tk.simulator.RpcInterface.__init__()=modbus_tk.simulator.RpcInterface-class.html#__init__,Method modbus_tk.simulator.Simulator.__init__()=modbus_tk.simulator.Simulator-class.html#__init__,Method modbus_tk.simulator_rpc_client.SimulatorRpcClient.__init__()=modbus_tk.simulator_rpc_client.SimulatorRpcClient-class.html#__init__,Method modbus_tk.utils.ConsoleHandler.__init__()=modbus_tk.utils.ConsoleHandler-class.html#__init__,Method modbus_tk.utils.DummyHandler.__init__()=modbus_tk.utils.DummyHandler-class.html#__init__,Method modbus_tk.utils.LogitHandler.__init__()=modbus_tk.utils.LogitHandler-class.html#__init__,Method modbus_tk.utils.WorkerThread.__init__()=modbus_tk.utils.WorkerThread-class.html#__init__"><a title="modbus_tk.modbus.Databank.__init__
modbus_tk.modbus.Master.__init__
modbus_tk.modbus.ModbusBlock.__init__
modbus_tk.modbus.ModbusError.__init__
modbus_tk.modbus.Query.__init__
modbus_tk.modbus.Server.__init__
modbus_tk.modbus.Slave.__init__
modbus_tk.modbus_rtu.RtuMaster.__init__
modbus_tk.modbus_rtu.RtuQuery.__init__
modbus_tk.modbus_rtu.RtuServer.__init__
modbus_tk.modbus_tcp.ModbusInvalidMbapError.__init__
modbus_tk.modbus_tcp.TcpMaster.__init__
modbus_tk.modbus_tcp.TcpMbap.__init__
modbus_tk.modbus_tcp.TcpQuery.__init__
modbus_tk.modbus_tcp.TcpServer.__init__
modbus_tk.simulator.CompositeServer.__init__
modbus_tk.simulator.ConsoleInterface.__init__
modbus_tk.simulator.RpcInterface.__init__
modbus_tk.simulator.Simulator.__init__
modbus_tk.simulator_rpc_client.SimulatorRpcClient.__init__
modbus_tk.utils.ConsoleHandler.__init__
modbus_tk.utils.DummyHandler.__init__
modbus_tk.utils.LogitHandler.__init__
modbus_tk.utils.WorkerThread.__init__" class="py-name" href="#" onclick="return doclink('link-5', '__init__', 'link-5');">__init__</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-name">value</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L25"></a><tt class="py-lineno"> 25</tt>  <tt class="py-line"> </tt>
<a name="TcpMbap"></a><div id="TcpMbap-def"><a name="L26"></a><tt class="py-lineno"> 26</tt>  <tt class="py-line"><tt class="py-comment">#-------------------------------------------------------------------------------</tt> </tt>
<a name="L27"></a><tt class="py-lineno"> 27</tt> <a class="py-toggle" href="#" id="TcpMbap-toggle" onclick="return toggle('TcpMbap');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="modbus_tk.modbus_tcp.TcpMbap-class.html">TcpMbap</a><tt class="py-op">:</tt> </tt>
</div><div id="TcpMbap-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="TcpMbap-expanded"><a name="L28"></a><tt class="py-lineno"> 28</tt>  <tt class="py-line">    <tt class="py-docstring">"""Defines the information added by the Modbus TCP layer"""</tt> </tt>
<a name="TcpMbap.__init__"></a><div id="TcpMbap.__init__-def"><a name="L29"></a><tt class="py-lineno"> 29</tt> <a class="py-toggle" href="#" id="TcpMbap.__init__-toggle" onclick="return toggle('TcpMbap.__init__');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus_tcp.TcpMbap-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="TcpMbap.__init__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="TcpMbap.__init__-expanded"><a name="L30"></a><tt class="py-lineno"> 30</tt>  <tt class="py-line">        <tt class="py-docstring">"""Constructor: initializes with 0"""</tt> </tt>
<a name="L31"></a><tt class="py-lineno"> 31</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">transaction_id</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L32"></a><tt class="py-lineno"> 32</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">protocol_id</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L33"></a><tt class="py-lineno"> 33</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">length</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L34"></a><tt class="py-lineno"> 34</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">unit_id</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
</div><a name="L35"></a><tt class="py-lineno"> 35</tt>  <tt class="py-line">         </tt>
<a name="TcpMbap.clone"></a><div id="TcpMbap.clone-def"><a name="L36"></a><tt class="py-lineno"> 36</tt> <a class="py-toggle" href="#" id="TcpMbap.clone-toggle" onclick="return toggle('TcpMbap.clone');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus_tcp.TcpMbap-class.html#clone">clone</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">mbap</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="TcpMbap.clone-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="TcpMbap.clone-expanded"><a name="L37"></a><tt class="py-lineno"> 37</tt>  <tt class="py-line">        <tt class="py-docstring">"""Set the value of each fields from another TcpMbap instance"""</tt> </tt>
<a name="L38"></a><tt class="py-lineno"> 38</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">transaction_id</tt> <tt class="py-op">=</tt> <tt class="py-name">mbap</tt><tt class="py-op">.</tt><tt class="py-name">transaction_id</tt> </tt>
<a name="L39"></a><tt class="py-lineno"> 39</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">protocol_id</tt> <tt class="py-op">=</tt> <tt class="py-name">mbap</tt><tt class="py-op">.</tt><tt class="py-name">protocol_id</tt> </tt>
<a name="L40"></a><tt class="py-lineno"> 40</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">length</tt> <tt class="py-op">=</tt> <tt class="py-name">mbap</tt><tt class="py-op">.</tt><tt class="py-name">length</tt> </tt>
<a name="L41"></a><tt class="py-lineno"> 41</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">unit_id</tt> <tt class="py-op">=</tt> <tt class="py-name">mbap</tt><tt class="py-op">.</tt><tt class="py-name">unit_id</tt> </tt>
</div><a name="L42"></a><tt class="py-lineno"> 42</tt>  <tt class="py-line">         </tt>
<a name="TcpMbap._check_ids"></a><div id="TcpMbap._check_ids-def"><a name="L43"></a><tt class="py-lineno"> 43</tt> <a class="py-toggle" href="#" id="TcpMbap._check_ids-toggle" onclick="return toggle('TcpMbap._check_ids');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus_tcp.TcpMbap-class.html#_check_ids">_check_ids</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">request_mbap</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="TcpMbap._check_ids-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="TcpMbap._check_ids-expanded"><a name="L44"></a><tt class="py-lineno"> 44</tt>  <tt class="py-line">        <tt class="py-docstring">"""</tt> </tt>
<a name="L45"></a><tt class="py-lineno"> 45</tt>  <tt class="py-line"><tt class="py-docstring">        Check that the ids in the request and the response are similar. </tt> </tt>
<a name="L46"></a><tt class="py-lineno"> 46</tt>  <tt class="py-line"><tt class="py-docstring">        if not returns a string describing the error</tt> </tt>
<a name="L47"></a><tt class="py-lineno"> 47</tt>  <tt class="py-line"><tt class="py-docstring">        """</tt> </tt>
<a name="L48"></a><tt class="py-lineno"> 48</tt>  <tt class="py-line">        <tt class="py-name">error_str</tt> <tt class="py-op">=</tt> <tt class="py-string">""</tt> </tt>
<a name="L49"></a><tt class="py-lineno"> 49</tt>  <tt class="py-line">         </tt>
<a name="L50"></a><tt class="py-lineno"> 50</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">request_mbap</tt><tt class="py-op">.</tt><tt class="py-name">transaction_id</tt> <tt class="py-op">!=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">transaction_id</tt><tt class="py-op">:</tt> </tt>
<a name="L51"></a><tt class="py-lineno"> 51</tt>  <tt class="py-line">            <tt class="py-name">error_str</tt> <tt class="py-op">+=</tt> <tt class="py-string">"Invalid transaction id: request=%d - response=%d. "</tt> <tt class="py-op">%</tt> \ </tt>
<a name="L52"></a><tt class="py-lineno"> 52</tt>  <tt class="py-line">                <tt class="py-op">(</tt><tt class="py-name">request_mbap</tt><tt class="py-op">.</tt><tt class="py-name">transaction_id</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">transaction_id</tt><tt class="py-op">)</tt> </tt>
<a name="L53"></a><tt class="py-lineno"> 53</tt>  <tt class="py-line">         </tt>
<a name="L54"></a><tt class="py-lineno"> 54</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">request_mbap</tt><tt class="py-op">.</tt><tt class="py-name">protocol_id</tt> <tt class="py-op">!=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">protocol_id</tt><tt class="py-op">:</tt> </tt>
<a name="L55"></a><tt class="py-lineno"> 55</tt>  <tt class="py-line">            <tt class="py-name">error_str</tt> <tt class="py-op">+=</tt> <tt class="py-string">"Invalid protocol id: request=%d - response=%d. "</tt> <tt class="py-op">%</tt> \ </tt>
<a name="L56"></a><tt class="py-lineno"> 56</tt>  <tt class="py-line">                <tt class="py-op">(</tt><tt class="py-name">request_mbap</tt><tt class="py-op">.</tt><tt class="py-name">protocol_id</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">protocol_id</tt><tt class="py-op">)</tt> </tt>
<a name="L57"></a><tt class="py-lineno"> 57</tt>  <tt class="py-line">         </tt>
<a name="L58"></a><tt class="py-lineno"> 58</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">request_mbap</tt><tt class="py-op">.</tt><tt class="py-name">unit_id</tt> <tt class="py-op">!=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">unit_id</tt><tt class="py-op">:</tt> </tt>
<a name="L59"></a><tt class="py-lineno"> 59</tt>  <tt class="py-line">            <tt class="py-name">error_str</tt> <tt class="py-op">+=</tt> <tt class="py-string">"Invalid unit id: request=%d - response=%d. "</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">request_mbap</tt><tt class="py-op">.</tt><tt class="py-name">unit_id</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">unit_id</tt><tt class="py-op">)</tt> </tt>
<a name="L60"></a><tt class="py-lineno"> 60</tt>  <tt class="py-line">                 </tt>
<a name="L61"></a><tt class="py-lineno"> 61</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">error_str</tt> </tt>
</div><a name="L62"></a><tt class="py-lineno"> 62</tt>  <tt class="py-line">                 </tt>
<a name="TcpMbap.check_length"></a><div id="TcpMbap.check_length-def"><a name="L63"></a><tt class="py-lineno"> 63</tt> <a class="py-toggle" href="#" id="TcpMbap.check_length-toggle" onclick="return toggle('TcpMbap.check_length');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus_tcp.TcpMbap-class.html#check_length">check_length</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">pdu_length</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="TcpMbap.check_length-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="TcpMbap.check_length-expanded"><a name="L64"></a><tt class="py-lineno"> 64</tt>  <tt class="py-line">        <tt class="py-docstring">"""Check the length field is valid. If not raise an exception"""</tt> </tt>
<a name="L65"></a><tt class="py-lineno"> 65</tt>  <tt class="py-line">        <tt class="py-name">following_bytes_length</tt> <tt class="py-op">=</tt> <tt class="py-name">pdu_length</tt><tt class="py-op">+</tt><tt class="py-number">1</tt> </tt>
<a name="L66"></a><tt class="py-lineno"> 66</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">length</tt> <tt class="py-op">!=</tt> <tt class="py-name">following_bytes_length</tt><tt class="py-op">:</tt> </tt>
<a name="L67"></a><tt class="py-lineno"> 67</tt>  <tt class="py-line">            <tt class="py-keyword">return</tt> <tt class="py-string">"Response length is %d while receiving %d bytes. "</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">length</tt><tt class="py-op">,</tt> <tt class="py-name">following_bytes_length</tt><tt class="py-op">)</tt> </tt>
<a name="L68"></a><tt class="py-lineno"> 68</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-string">""</tt> </tt>
</div><a name="L69"></a><tt class="py-lineno"> 69</tt>  <tt class="py-line">     </tt>
<a name="TcpMbap.check_response"></a><div id="TcpMbap.check_response-def"><a name="L70"></a><tt class="py-lineno"> 70</tt> <a class="py-toggle" href="#" id="TcpMbap.check_response-toggle" onclick="return toggle('TcpMbap.check_response');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus_tcp.TcpMbap-class.html#check_response">check_response</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">request_mbap</tt><tt class="py-op">,</tt> <tt class="py-param">response_pdu_length</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="TcpMbap.check_response-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="TcpMbap.check_response-expanded"><a name="L71"></a><tt class="py-lineno"> 71</tt>  <tt class="py-line">        <tt class="py-docstring">"""Check that the MBAP of the response is valid. If not raise an exception"""</tt> </tt>
<a name="L72"></a><tt class="py-lineno"> 72</tt>  <tt class="py-line">        <tt class="py-name">error_str</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-6" class="py-name" targets="Method modbus_tk.modbus_tcp.TcpMbap._check_ids()=modbus_tk.modbus_tcp.TcpMbap-class.html#_check_ids"><a title="modbus_tk.modbus_tcp.TcpMbap._check_ids" class="py-name" href="#" onclick="return doclink('link-6', '_check_ids', 'link-6');">_check_ids</a></tt><tt class="py-op">(</tt><tt class="py-name">request_mbap</tt><tt class="py-op">)</tt> </tt>
<a name="L73"></a><tt class="py-lineno"> 73</tt>  <tt class="py-line">        <tt class="py-name">error_str</tt> <tt class="py-op">+=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-7" class="py-name" targets="Method modbus_tk.modbus_tcp.TcpMbap.check_length()=modbus_tk.modbus_tcp.TcpMbap-class.html#check_length"><a title="modbus_tk.modbus_tcp.TcpMbap.check_length" class="py-name" href="#" onclick="return doclink('link-7', 'check_length', 'link-7');">check_length</a></tt><tt class="py-op">(</tt><tt class="py-name">response_pdu_length</tt><tt class="py-op">)</tt> </tt>
<a name="L74"></a><tt class="py-lineno"> 74</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">error_str</tt><tt class="py-op">)</tt><tt class="py-op">&gt;</tt><tt class="py-number">0</tt><tt class="py-op">:</tt> </tt>
<a name="L75"></a><tt class="py-lineno"> 75</tt>  <tt class="py-line">            <tt class="py-keyword">raise</tt> <tt id="link-8" class="py-name" targets="Class modbus_tk.modbus_tcp.ModbusInvalidMbapError=modbus_tk.modbus_tcp.ModbusInvalidMbapError-class.html"><a title="modbus_tk.modbus_tcp.ModbusInvalidMbapError" class="py-name" href="#" onclick="return doclink('link-8', 'ModbusInvalidMbapError', 'link-8');">ModbusInvalidMbapError</a></tt><tt class="py-op">,</tt> <tt class="py-name">error_str</tt> </tt>
</div><a name="L76"></a><tt class="py-lineno"> 76</tt>  <tt class="py-line">         </tt>
<a name="TcpMbap.pack"></a><div id="TcpMbap.pack-def"><a name="L77"></a><tt class="py-lineno"> 77</tt> <a class="py-toggle" href="#" id="TcpMbap.pack-toggle" onclick="return toggle('TcpMbap.pack');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus_tcp.TcpMbap-class.html#pack">pack</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="TcpMbap.pack-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="TcpMbap.pack-expanded"><a name="L78"></a><tt class="py-lineno"> 78</tt>  <tt class="py-line">        <tt class="py-docstring">"""convert the TCP mbap into a string"""</tt> </tt>
<a name="L79"></a><tt class="py-lineno"> 79</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">struct</tt><tt class="py-op">.</tt><tt id="link-9" class="py-name" targets="Method modbus_tk.modbus_tcp.TcpMbap.pack()=modbus_tk.modbus_tcp.TcpMbap-class.html#pack"><a title="modbus_tk.modbus_tcp.TcpMbap.pack" class="py-name" href="#" onclick="return doclink('link-9', 'pack', 'link-9');">pack</a></tt><tt class="py-op">(</tt><tt class="py-string">"&gt;HHHB"</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">transaction_id</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">protocol_id</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">length</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">unit_id</tt><tt class="py-op">)</tt> </tt>
</div><a name="L80"></a><tt class="py-lineno"> 80</tt>  <tt class="py-line">         </tt>
<a name="TcpMbap.unpack"></a><div id="TcpMbap.unpack-def"><a name="L81"></a><tt class="py-lineno"> 81</tt> <a class="py-toggle" href="#" id="TcpMbap.unpack-toggle" onclick="return toggle('TcpMbap.unpack');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus_tcp.TcpMbap-class.html#unpack">unpack</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">value</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="TcpMbap.unpack-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="TcpMbap.unpack-expanded"><a name="L82"></a><tt class="py-lineno"> 82</tt>  <tt class="py-line">        <tt class="py-docstring">"""extract the TCP mbap from a string"""</tt> </tt>
<a name="L83"></a><tt class="py-lineno"> 83</tt>  <tt class="py-line">        <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">transaction_id</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">protocol_id</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">length</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">unit_id</tt><tt class="py-op">)</tt> <tt class="py-op">=</tt> <tt class="py-name">struct</tt><tt class="py-op">.</tt><tt id="link-10" class="py-name" targets="Method modbus_tk.modbus_tcp.TcpMbap.unpack()=modbus_tk.modbus_tcp.TcpMbap-class.html#unpack"><a title="modbus_tk.modbus_tcp.TcpMbap.unpack" class="py-name" href="#" onclick="return doclink('link-10', 'unpack', 'link-10');">unpack</a></tt><tt class="py-op">(</tt><tt class="py-string">"&gt;HHHB"</tt><tt class="py-op">,</tt> <tt class="py-name">value</tt><tt class="py-op">)</tt>  </tt>
</div></div><a name="L84"></a><tt class="py-lineno"> 84</tt>  <tt class="py-line">            </tt>
<a name="TcpQuery"></a><div id="TcpQuery-def"><a name="L85"></a><tt class="py-lineno"> 85</tt>  <tt class="py-line"><tt class="py-comment">#-------------------------------------------------------------------------------</tt> </tt>
<a name="L86"></a><tt class="py-lineno"> 86</tt> <a class="py-toggle" href="#" id="TcpQuery-toggle" onclick="return toggle('TcpQuery');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="modbus_tk.modbus_tcp.TcpQuery-class.html">TcpQuery</a><tt class="py-op">(</tt><tt class="py-base-class">Query</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="TcpQuery-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="TcpQuery-expanded"><a name="L87"></a><tt class="py-lineno"> 87</tt>  <tt class="py-line">    <tt class="py-docstring">"""Subclass of a Query. Adds the Modbus TCP specific part of the protocol"""</tt>     </tt>
<a name="L88"></a><tt class="py-lineno"> 88</tt>  <tt class="py-line">     </tt>
<a name="L89"></a><tt class="py-lineno"> 89</tt>  <tt class="py-line">    <tt class="py-comment">#static variable for giving a unique id to each query</tt> </tt>
<a name="L90"></a><tt class="py-lineno"> 90</tt>  <tt class="py-line">    <tt id="link-11" class="py-name" targets="Variable modbus_tk.modbus_tcp.TcpQuery._last_transaction_id=modbus_tk.modbus_tcp.TcpQuery-class.html#_last_transaction_id"><a title="modbus_tk.modbus_tcp.TcpQuery._last_transaction_id" class="py-name" href="#" onclick="return doclink('link-11', '_last_transaction_id', 'link-11');">_last_transaction_id</a></tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L91"></a><tt class="py-lineno"> 91</tt>  <tt class="py-line">     </tt>
<a name="TcpQuery.__init__"></a><div id="TcpQuery.__init__-def"><a name="L92"></a><tt class="py-lineno"> 92</tt> <a class="py-toggle" href="#" id="TcpQuery.__init__-toggle" onclick="return toggle('TcpQuery.__init__');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus_tcp.TcpQuery-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="TcpQuery.__init__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="TcpQuery.__init__-expanded"><a name="L93"></a><tt class="py-lineno"> 93</tt>  <tt class="py-line">        <tt class="py-docstring">"""Constructor"""</tt> </tt>
<a name="L94"></a><tt class="py-lineno"> 94</tt>  <tt class="py-line">        <tt id="link-12" class="py-name" targets="Class modbus_tk.modbus.Query=modbus_tk.modbus.Query-class.html"><a title="modbus_tk.modbus.Query" class="py-name" href="#" onclick="return doclink('link-12', 'Query', 'link-12');">Query</a></tt><tt class="py-op">.</tt><tt id="link-13" class="py-name"><a title="modbus_tk.modbus.Databank.__init__
modbus_tk.modbus.Master.__init__
modbus_tk.modbus.ModbusBlock.__init__
modbus_tk.modbus.ModbusError.__init__
modbus_tk.modbus.Query.__init__
modbus_tk.modbus.Server.__init__
modbus_tk.modbus.Slave.__init__
modbus_tk.modbus_rtu.RtuMaster.__init__
modbus_tk.modbus_rtu.RtuQuery.__init__
modbus_tk.modbus_rtu.RtuServer.__init__
modbus_tk.modbus_tcp.ModbusInvalidMbapError.__init__
modbus_tk.modbus_tcp.TcpMaster.__init__
modbus_tk.modbus_tcp.TcpMbap.__init__
modbus_tk.modbus_tcp.TcpQuery.__init__
modbus_tk.modbus_tcp.TcpServer.__init__
modbus_tk.simulator.CompositeServer.__init__
modbus_tk.simulator.ConsoleInterface.__init__
modbus_tk.simulator.RpcInterface.__init__
modbus_tk.simulator.Simulator.__init__
modbus_tk.simulator_rpc_client.SimulatorRpcClient.__init__
modbus_tk.utils.ConsoleHandler.__init__
modbus_tk.utils.DummyHandler.__init__
modbus_tk.utils.LogitHandler.__init__
modbus_tk.utils.WorkerThread.__init__" class="py-name" href="#" onclick="return doclink('link-13', '__init__', 'link-5');">__init__</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">)</tt> </tt>
<a name="L95"></a><tt class="py-lineno"> 95</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_request_mbap</tt> <tt class="py-op">=</tt> <tt id="link-14" class="py-name" targets="Class modbus_tk.modbus_tcp.TcpMbap=modbus_tk.modbus_tcp.TcpMbap-class.html"><a title="modbus_tk.modbus_tcp.TcpMbap" class="py-name" href="#" onclick="return doclink('link-14', 'TcpMbap', 'link-14');">TcpMbap</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L96"></a><tt class="py-lineno"> 96</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_response_mbap</tt> <tt class="py-op">=</tt> <tt id="link-15" class="py-name"><a title="modbus_tk.modbus_tcp.TcpMbap" class="py-name" href="#" onclick="return doclink('link-15', 'TcpMbap', 'link-14');">TcpMbap</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L97"></a><tt class="py-lineno"> 97</tt>  <tt class="py-line">          </tt>
<a name="L98"></a><tt class="py-lineno"> 98</tt>  <tt class="py-line">    <tt class="py-decorator">@</tt><tt class="py-decorator">threadsafe_function</tt>      </tt>
<a name="TcpQuery._get_transaction_id"></a><div id="TcpQuery._get_transaction_id-def"><a name="L99"></a><tt class="py-lineno"> 99</tt> <a class="py-toggle" href="#" id="TcpQuery._get_transaction_id-toggle" onclick="return toggle('TcpQuery._get_transaction_id');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus_tcp.TcpQuery-class.html#_get_transaction_id">_get_transaction_id</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="TcpQuery._get_transaction_id-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="TcpQuery._get_transaction_id-expanded"><a name="L100"></a><tt class="py-lineno">100</tt>  <tt class="py-line">        <tt class="py-docstring">"""returns an identifier for the query"""</tt> </tt>
<a name="L101"></a><tt class="py-lineno">101</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt id="link-16" class="py-name" targets="Class modbus_tk.modbus_tcp.TcpQuery=modbus_tk.modbus_tcp.TcpQuery-class.html"><a title="modbus_tk.modbus_tcp.TcpQuery" class="py-name" href="#" onclick="return doclink('link-16', 'TcpQuery', 'link-16');">TcpQuery</a></tt><tt class="py-op">.</tt><tt id="link-17" class="py-name"><a title="modbus_tk.modbus_tcp.TcpQuery._last_transaction_id" class="py-name" href="#" onclick="return doclink('link-17', '_last_transaction_id', 'link-11');">_last_transaction_id</a></tt> <tt class="py-op">&lt;</tt> <tt class="py-number">0xffff</tt><tt class="py-op">:</tt> </tt>
<a name="L102"></a><tt class="py-lineno">102</tt>  <tt class="py-line">            <tt id="link-18" class="py-name"><a title="modbus_tk.modbus_tcp.TcpQuery" class="py-name" href="#" onclick="return doclink('link-18', 'TcpQuery', 'link-16');">TcpQuery</a></tt><tt class="py-op">.</tt><tt id="link-19" class="py-name"><a title="modbus_tk.modbus_tcp.TcpQuery._last_transaction_id" class="py-name" href="#" onclick="return doclink('link-19', '_last_transaction_id', 'link-11');">_last_transaction_id</a></tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> </tt>
<a name="L103"></a><tt class="py-lineno">103</tt>  <tt class="py-line">        <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L104"></a><tt class="py-lineno">104</tt>  <tt class="py-line">            <tt id="link-20" class="py-name"><a title="modbus_tk.modbus_tcp.TcpQuery" class="py-name" href="#" onclick="return doclink('link-20', 'TcpQuery', 'link-16');">TcpQuery</a></tt><tt class="py-op">.</tt><tt id="link-21" class="py-name"><a title="modbus_tk.modbus_tcp.TcpQuery._last_transaction_id" class="py-name" href="#" onclick="return doclink('link-21', '_last_transaction_id', 'link-11');">_last_transaction_id</a></tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L105"></a><tt class="py-lineno">105</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt id="link-22" class="py-name"><a title="modbus_tk.modbus_tcp.TcpQuery" class="py-name" href="#" onclick="return doclink('link-22', 'TcpQuery', 'link-16');">TcpQuery</a></tt><tt class="py-op">.</tt><tt id="link-23" class="py-name"><a title="modbus_tk.modbus_tcp.TcpQuery._last_transaction_id" class="py-name" href="#" onclick="return doclink('link-23', '_last_transaction_id', 'link-11');">_last_transaction_id</a></tt> </tt>
</div><a name="L106"></a><tt class="py-lineno">106</tt>  <tt class="py-line">     </tt>
<a name="TcpQuery.build_request"></a><div id="TcpQuery.build_request-def"><a name="L107"></a><tt class="py-lineno">107</tt> <a class="py-toggle" href="#" id="TcpQuery.build_request-toggle" onclick="return toggle('TcpQuery.build_request');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus_tcp.TcpQuery-class.html#build_request">build_request</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">pdu</tt><tt class="py-op">,</tt> <tt class="py-param">slave</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="TcpQuery.build_request-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="TcpQuery.build_request-expanded"><a name="L108"></a><tt class="py-lineno">108</tt>  <tt class="py-line">        <tt class="py-docstring">"""Add the Modbus TCP part to the request"""</tt> </tt>
<a name="L109"></a><tt class="py-lineno">109</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">slave</tt> <tt class="py-op">&lt;</tt> <tt class="py-number">0</tt><tt class="py-op">)</tt> <tt class="py-keyword">or</tt> <tt class="py-op">(</tt><tt class="py-name">slave</tt> <tt class="py-op">&gt;=</tt> <tt class="py-number">256</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L110"></a><tt class="py-lineno">110</tt>  <tt class="py-line">            <tt class="py-keyword">raise</tt> <tt id="link-24" class="py-name" targets="Class modbus_tk.modbus.InvalidArgumentError=modbus_tk.modbus.InvalidArgumentError-class.html"><a title="modbus_tk.modbus.InvalidArgumentError" class="py-name" href="#" onclick="return doclink('link-24', 'InvalidArgumentError', 'link-24');">InvalidArgumentError</a></tt><tt class="py-op">,</tt> <tt class="py-string">"%d Invalid value for slave id"</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">slave</tt><tt class="py-op">)</tt> </tt>
<a name="L111"></a><tt class="py-lineno">111</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_request_mbap</tt><tt class="py-op">.</tt><tt class="py-name">length</tt> <tt class="py-op">=</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">pdu</tt><tt class="py-op">)</tt><tt class="py-op">+</tt><tt class="py-number">1</tt> </tt>
<a name="L112"></a><tt class="py-lineno">112</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_request_mbap</tt><tt class="py-op">.</tt><tt class="py-name">transaction_id</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-25" class="py-name" targets="Method modbus_tk.modbus_tcp.TcpQuery._get_transaction_id()=modbus_tk.modbus_tcp.TcpQuery-class.html#_get_transaction_id"><a title="modbus_tk.modbus_tcp.TcpQuery._get_transaction_id" class="py-name" href="#" onclick="return doclink('link-25', '_get_transaction_id', 'link-25');">_get_transaction_id</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L113"></a><tt class="py-lineno">113</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_request_mbap</tt><tt class="py-op">.</tt><tt class="py-name">unit_id</tt> <tt class="py-op">=</tt> <tt class="py-name">slave</tt> </tt>
<a name="L114"></a><tt class="py-lineno">114</tt>  <tt class="py-line">        <tt class="py-name">mbap</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_request_mbap</tt><tt class="py-op">.</tt><tt id="link-26" class="py-name"><a title="modbus_tk.modbus_tcp.TcpMbap.pack" class="py-name" href="#" onclick="return doclink('link-26', 'pack', 'link-9');">pack</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L115"></a><tt class="py-lineno">115</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">mbap</tt><tt class="py-op">+</tt><tt class="py-name">pdu</tt> </tt>
</div><a name="L116"></a><tt class="py-lineno">116</tt>  <tt class="py-line">     </tt>
<a name="TcpQuery.parse_response"></a><div id="TcpQuery.parse_response-def"><a name="L117"></a><tt class="py-lineno">117</tt> <a class="py-toggle" href="#" id="TcpQuery.parse_response-toggle" onclick="return toggle('TcpQuery.parse_response');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus_tcp.TcpQuery-class.html#parse_response">parse_response</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">response</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="TcpQuery.parse_response-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="TcpQuery.parse_response-expanded"><a name="L118"></a><tt class="py-lineno">118</tt>  <tt class="py-line">        <tt class="py-docstring">"""Extract the pdu from the Modbus TCP response"""</tt> </tt>
<a name="L119"></a><tt class="py-lineno">119</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">response</tt><tt class="py-op">)</tt> <tt class="py-op">&gt;</tt> <tt class="py-number">6</tt><tt class="py-op">:</tt> </tt>
<a name="L120"></a><tt class="py-lineno">120</tt>  <tt class="py-line">            <tt class="py-name">mbap</tt><tt class="py-op">,</tt> <tt class="py-name">pdu</tt> <tt class="py-op">=</tt> <tt class="py-name">response</tt><tt class="py-op">[</tt><tt class="py-op">:</tt><tt class="py-number">7</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-name">response</tt><tt class="py-op">[</tt><tt class="py-number">7</tt><tt class="py-op">:</tt><tt class="py-op">]</tt> </tt>
<a name="L121"></a><tt class="py-lineno">121</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_response_mbap</tt><tt class="py-op">.</tt><tt id="link-27" class="py-name"><a title="modbus_tk.modbus_tcp.TcpMbap.unpack" class="py-name" href="#" onclick="return doclink('link-27', 'unpack', 'link-10');">unpack</a></tt><tt class="py-op">(</tt><tt class="py-name">mbap</tt><tt class="py-op">)</tt> </tt>
<a name="L122"></a><tt class="py-lineno">122</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_response_mbap</tt><tt class="py-op">.</tt><tt id="link-28" class="py-name" targets="Method modbus_tk.modbus_tcp.TcpMbap.check_response()=modbus_tk.modbus_tcp.TcpMbap-class.html#check_response"><a title="modbus_tk.modbus_tcp.TcpMbap.check_response" class="py-name" href="#" onclick="return doclink('link-28', 'check_response', 'link-28');">check_response</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_request_mbap</tt><tt class="py-op">,</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">pdu</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L123"></a><tt class="py-lineno">123</tt>  <tt class="py-line">            <tt class="py-keyword">return</tt> <tt class="py-name">pdu</tt> </tt>
<a name="L124"></a><tt class="py-lineno">124</tt>  <tt class="py-line">        <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L125"></a><tt class="py-lineno">125</tt>  <tt class="py-line">            <tt class="py-keyword">raise</tt> <tt id="link-29" class="py-name" targets="Class modbus_tk.modbus.ModbusInvalidResponseError=modbus_tk.modbus.ModbusInvalidResponseError-class.html"><a title="modbus_tk.modbus.ModbusInvalidResponseError" class="py-name" href="#" onclick="return doclink('link-29', 'ModbusInvalidResponseError', 'link-29');">ModbusInvalidResponseError</a></tt><tt class="py-op">,</tt> <tt class="py-string">"Response length is only %d bytes. "</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">response</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
</div><a name="L126"></a><tt class="py-lineno">126</tt>  <tt class="py-line">         </tt>
<a name="TcpQuery.parse_request"></a><div id="TcpQuery.parse_request-def"><a name="L127"></a><tt class="py-lineno">127</tt> <a class="py-toggle" href="#" id="TcpQuery.parse_request-toggle" onclick="return toggle('TcpQuery.parse_request');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus_tcp.TcpQuery-class.html#parse_request">parse_request</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">request</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="TcpQuery.parse_request-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="TcpQuery.parse_request-expanded"><a name="L128"></a><tt class="py-lineno">128</tt>  <tt class="py-line">        <tt class="py-docstring">"""Extract the pdu from a modbus request"""</tt> </tt>
<a name="L129"></a><tt class="py-lineno">129</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">request</tt><tt class="py-op">)</tt> <tt class="py-op">&gt;</tt> <tt class="py-number">6</tt><tt class="py-op">:</tt> </tt>
<a name="L130"></a><tt class="py-lineno">130</tt>  <tt class="py-line">            <tt class="py-name">mbap</tt><tt class="py-op">,</tt> <tt class="py-name">pdu</tt> <tt class="py-op">=</tt> <tt class="py-name">request</tt><tt class="py-op">[</tt><tt class="py-op">:</tt><tt class="py-number">7</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-name">request</tt><tt class="py-op">[</tt><tt class="py-number">7</tt><tt class="py-op">:</tt><tt class="py-op">]</tt> </tt>
<a name="L131"></a><tt class="py-lineno">131</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_request_mbap</tt><tt class="py-op">.</tt><tt id="link-30" class="py-name"><a title="modbus_tk.modbus_tcp.TcpMbap.unpack" class="py-name" href="#" onclick="return doclink('link-30', 'unpack', 'link-10');">unpack</a></tt><tt class="py-op">(</tt><tt class="py-name">mbap</tt><tt class="py-op">)</tt> </tt>
<a name="L132"></a><tt class="py-lineno">132</tt>  <tt class="py-line">            <tt class="py-name">error_str</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_request_mbap</tt><tt class="py-op">.</tt><tt id="link-31" class="py-name"><a title="modbus_tk.modbus_tcp.TcpMbap.check_length" class="py-name" href="#" onclick="return doclink('link-31', 'check_length', 'link-7');">check_length</a></tt><tt class="py-op">(</tt><tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">pdu</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L133"></a><tt class="py-lineno">133</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">error_str</tt><tt class="py-op">)</tt> <tt class="py-op">&gt;</tt> <tt class="py-number">0</tt><tt class="py-op">:</tt> </tt>
<a name="L134"></a><tt class="py-lineno">134</tt>  <tt class="py-line">                <tt class="py-keyword">raise</tt> <tt id="link-32" class="py-name"><a title="modbus_tk.modbus_tcp.ModbusInvalidMbapError" class="py-name" href="#" onclick="return doclink('link-32', 'ModbusInvalidMbapError', 'link-8');">ModbusInvalidMbapError</a></tt><tt class="py-op">,</tt> <tt class="py-name">error_str</tt> </tt>
<a name="L135"></a><tt class="py-lineno">135</tt>  <tt class="py-line">            <tt class="py-keyword">return</tt> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_request_mbap</tt><tt class="py-op">.</tt><tt class="py-name">unit_id</tt><tt class="py-op">,</tt> <tt class="py-name">pdu</tt><tt class="py-op">)</tt> </tt>
<a name="L136"></a><tt class="py-lineno">136</tt>  <tt class="py-line">        <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L137"></a><tt class="py-lineno">137</tt>  <tt class="py-line">            <tt class="py-keyword">raise</tt> <tt id="link-33" class="py-name" targets="Class modbus_tk.modbus.ModbusInvalidRequestError=modbus_tk.modbus.ModbusInvalidRequestError-class.html"><a title="modbus_tk.modbus.ModbusInvalidRequestError" class="py-name" href="#" onclick="return doclink('link-33', 'ModbusInvalidRequestError', 'link-33');">ModbusInvalidRequestError</a></tt><tt class="py-op">,</tt> <tt class="py-string">"Request length is only %d bytes. "</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">request</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
</div><a name="L138"></a><tt class="py-lineno">138</tt>  <tt class="py-line">     </tt>
<a name="TcpQuery.build_response"></a><div id="TcpQuery.build_response-def"><a name="L139"></a><tt class="py-lineno">139</tt> <a class="py-toggle" href="#" id="TcpQuery.build_response-toggle" onclick="return toggle('TcpQuery.build_response');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus_tcp.TcpQuery-class.html#build_response">build_response</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">response_pdu</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="TcpQuery.build_response-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="TcpQuery.build_response-expanded"><a name="L140"></a><tt class="py-lineno">140</tt>  <tt class="py-line">        <tt class="py-docstring">"""Build the response"""</tt> </tt>
<a name="L141"></a><tt class="py-lineno">141</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_response_mbap</tt><tt class="py-op">.</tt><tt id="link-34" class="py-name" targets="Method modbus_tk.modbus_tcp.TcpMbap.clone()=modbus_tk.modbus_tcp.TcpMbap-class.html#clone"><a title="modbus_tk.modbus_tcp.TcpMbap.clone" class="py-name" href="#" onclick="return doclink('link-34', 'clone', 'link-34');">clone</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_request_mbap</tt><tt class="py-op">)</tt> </tt>
<a name="L142"></a><tt class="py-lineno">142</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_response_mbap</tt><tt class="py-op">.</tt><tt class="py-name">length</tt> <tt class="py-op">=</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">response_pdu</tt><tt class="py-op">)</tt> <tt class="py-op">+</tt> <tt class="py-number">1</tt> </tt>
<a name="L143"></a><tt class="py-lineno">143</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_response_mbap</tt><tt class="py-op">.</tt><tt id="link-35" class="py-name"><a title="modbus_tk.modbus_tcp.TcpMbap.pack" class="py-name" href="#" onclick="return doclink('link-35', 'pack', 'link-9');">pack</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> <tt class="py-op">+</tt> <tt class="py-name">response_pdu</tt> </tt>
</div></div><a name="L144"></a><tt class="py-lineno">144</tt>  <tt class="py-line"> </tt>
<a name="TcpMaster"></a><div id="TcpMaster-def"><a name="L145"></a><tt class="py-lineno">145</tt>  <tt class="py-line"><tt class="py-comment">#-------------------------------------------------------------------------------</tt> </tt>
<a name="L146"></a><tt class="py-lineno">146</tt> <a class="py-toggle" href="#" id="TcpMaster-toggle" onclick="return toggle('TcpMaster');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="modbus_tk.modbus_tcp.TcpMaster-class.html">TcpMaster</a><tt class="py-op">(</tt><tt class="py-base-class">Master</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="TcpMaster-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="TcpMaster-expanded"><a name="L147"></a><tt class="py-lineno">147</tt>  <tt class="py-line">    <tt class="py-docstring">"""Subclass of Master. Implements the Modbus TCP MAC layer"""</tt> </tt>
<a name="L148"></a><tt class="py-lineno">148</tt>  <tt class="py-line">     </tt>
<a name="TcpMaster.__init__"></a><div id="TcpMaster.__init__-def"><a name="L149"></a><tt class="py-lineno">149</tt> <a class="py-toggle" href="#" id="TcpMaster.__init__-toggle" onclick="return toggle('TcpMaster.__init__');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus_tcp.TcpMaster-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">host</tt><tt class="py-op">=</tt><tt class="py-string">"127.0.0.1"</tt><tt class="py-op">,</tt> <tt class="py-param">port</tt><tt class="py-op">=</tt><tt class="py-number">502</tt><tt class="py-op">,</tt> <tt class="py-param">timeout_in_sec</tt><tt class="py-op">=</tt><tt class="py-number">5.0</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="TcpMaster.__init__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="TcpMaster.__init__-expanded"><a name="L150"></a><tt class="py-lineno">150</tt>  <tt class="py-line">        <tt class="py-docstring">"""Constructor. Set the communication settings"""</tt> </tt>
<a name="L151"></a><tt class="py-lineno">151</tt>  <tt class="py-line">        <tt id="link-36" class="py-name" targets="Class modbus_tk.modbus.Master=modbus_tk.modbus.Master-class.html"><a title="modbus_tk.modbus.Master" class="py-name" href="#" onclick="return doclink('link-36', 'Master', 'link-36');">Master</a></tt><tt class="py-op">.</tt><tt id="link-37" class="py-name"><a title="modbus_tk.modbus.Databank.__init__
modbus_tk.modbus.Master.__init__
modbus_tk.modbus.ModbusBlock.__init__
modbus_tk.modbus.ModbusError.__init__
modbus_tk.modbus.Query.__init__
modbus_tk.modbus.Server.__init__
modbus_tk.modbus.Slave.__init__
modbus_tk.modbus_rtu.RtuMaster.__init__
modbus_tk.modbus_rtu.RtuQuery.__init__
modbus_tk.modbus_rtu.RtuServer.__init__
modbus_tk.modbus_tcp.ModbusInvalidMbapError.__init__
modbus_tk.modbus_tcp.TcpMaster.__init__
modbus_tk.modbus_tcp.TcpMbap.__init__
modbus_tk.modbus_tcp.TcpQuery.__init__
modbus_tk.modbus_tcp.TcpServer.__init__
modbus_tk.simulator.CompositeServer.__init__
modbus_tk.simulator.ConsoleInterface.__init__
modbus_tk.simulator.RpcInterface.__init__
modbus_tk.simulator.Simulator.__init__
modbus_tk.simulator_rpc_client.SimulatorRpcClient.__init__
modbus_tk.utils.ConsoleHandler.__init__
modbus_tk.utils.DummyHandler.__init__
modbus_tk.utils.LogitHandler.__init__
modbus_tk.utils.WorkerThread.__init__" class="py-name" href="#" onclick="return doclink('link-37', '__init__', 'link-5');">__init__</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-name">timeout_in_sec</tt><tt class="py-op">)</tt> </tt>
<a name="L152"></a><tt class="py-lineno">152</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_host</tt> <tt class="py-op">=</tt> <tt class="py-name">host</tt> </tt>
<a name="L153"></a><tt class="py-lineno">153</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_port</tt> <tt class="py-op">=</tt> <tt class="py-name">port</tt> </tt>
<a name="L154"></a><tt class="py-lineno">154</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_sock</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
</div><a name="L155"></a><tt class="py-lineno">155</tt>  <tt class="py-line">         </tt>
<a name="TcpMaster._do_open"></a><div id="TcpMaster._do_open-def"><a name="L156"></a><tt class="py-lineno">156</tt> <a class="py-toggle" href="#" id="TcpMaster._do_open-toggle" onclick="return toggle('TcpMaster._do_open');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus_tcp.TcpMaster-class.html#_do_open">_do_open</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="TcpMaster._do_open-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="TcpMaster._do_open-expanded"><a name="L157"></a><tt class="py-lineno">157</tt>  <tt class="py-line">        <tt class="py-docstring">"""Connect to the Modbus slave"""</tt> </tt>
<a name="L158"></a><tt class="py-lineno">158</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_sock</tt><tt class="py-op">:</tt> </tt>
<a name="L159"></a><tt class="py-lineno">159</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_sock</tt><tt class="py-op">.</tt><tt id="link-38" class="py-name" targets="Method modbus_tk.modbus.Master.close()=modbus_tk.modbus.Master-class.html#close,Method modbus_tk.modbus_rtu.RtuServer.close()=modbus_tk.modbus_rtu.RtuServer-class.html#close,Method modbus_tk.simulator.ConsoleInterface.close()=modbus_tk.simulator.ConsoleInterface-class.html#close,Method modbus_tk.simulator.RpcInterface.close()=modbus_tk.simulator.RpcInterface-class.html#close,Method modbus_tk.simulator.Simulator.close()=modbus_tk.simulator.Simulator-class.html#close"><a title="modbus_tk.modbus.Master.close
modbus_tk.modbus_rtu.RtuServer.close
modbus_tk.simulator.ConsoleInterface.close
modbus_tk.simulator.RpcInterface.close
modbus_tk.simulator.Simulator.close" class="py-name" href="#" onclick="return doclink('link-38', 'close', 'link-38');">close</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L160"></a><tt class="py-lineno">160</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_sock</tt> <tt class="py-op">=</tt> <tt class="py-name">socket</tt><tt class="py-op">.</tt><tt class="py-name">socket</tt><tt class="py-op">(</tt><tt class="py-name">socket</tt><tt class="py-op">.</tt><tt class="py-name">AF_INET</tt><tt class="py-op">,</tt> <tt class="py-name">socket</tt><tt class="py-op">.</tt><tt class="py-name">SOCK_STREAM</tt><tt class="py-op">)</tt> </tt>
<a name="L161"></a><tt class="py-lineno">161</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-39" class="py-name" targets="Method modbus_tk.modbus.Master.set_timeout()=modbus_tk.modbus.Master-class.html#set_timeout,Method modbus_tk.modbus_rtu.RtuMaster.set_timeout()=modbus_tk.modbus_rtu.RtuMaster-class.html#set_timeout,Method modbus_tk.modbus_tcp.TcpMaster.set_timeout()=modbus_tk.modbus_tcp.TcpMaster-class.html#set_timeout"><a title="modbus_tk.modbus.Master.set_timeout
modbus_tk.modbus_rtu.RtuMaster.set_timeout
modbus_tk.modbus_tcp.TcpMaster.set_timeout" class="py-name" href="#" onclick="return doclink('link-39', 'set_timeout', 'link-39');">set_timeout</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-40" class="py-name" targets="Method modbus_tk.modbus.Master.get_timeout()=modbus_tk.modbus.Master-class.html#get_timeout"><a title="modbus_tk.modbus.Master.get_timeout" class="py-name" href="#" onclick="return doclink('link-40', 'get_timeout', 'link-40');">get_timeout</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L162"></a><tt class="py-lineno">162</tt>  <tt class="py-line">        <tt id="link-41" class="py-name"><a title="modbus_tk.hooks.call_hooks" class="py-name" href="#" onclick="return doclink('link-41', 'call_hooks', 'link-2');">call_hooks</a></tt><tt class="py-op">(</tt><tt class="py-string">"modbus_tcp.TcpMaster.before_connect"</tt><tt class="py-op">,</tt> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L163"></a><tt class="py-lineno">163</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_sock</tt><tt class="py-op">.</tt><tt class="py-name">connect</tt><tt class="py-op">(</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_host</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_port</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L164"></a><tt class="py-lineno">164</tt>  <tt class="py-line">        <tt id="link-42" class="py-name"><a title="modbus_tk.hooks.call_hooks" class="py-name" href="#" onclick="return doclink('link-42', 'call_hooks', 'link-2');">call_hooks</a></tt><tt class="py-op">(</tt><tt class="py-string">"modbus_tcp.TcpMaster.after_connect"</tt><tt class="py-op">,</tt> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-op">)</tt><tt class="py-op">)</tt>     </tt>
</div><a name="L165"></a><tt class="py-lineno">165</tt>  <tt class="py-line">             </tt>
<a name="TcpMaster._do_close"></a><div id="TcpMaster._do_close-def"><a name="L166"></a><tt class="py-lineno">166</tt> <a class="py-toggle" href="#" id="TcpMaster._do_close-toggle" onclick="return toggle('TcpMaster._do_close');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus_tcp.TcpMaster-class.html#_do_close">_do_close</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="TcpMaster._do_close-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="TcpMaster._do_close-expanded"><a name="L167"></a><tt class="py-lineno">167</tt>  <tt class="py-line">        <tt class="py-docstring">"""Close the connection with the Modbus Slave"""</tt> </tt>
<a name="L168"></a><tt class="py-lineno">168</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_sock</tt><tt class="py-op">:</tt> </tt>
<a name="L169"></a><tt class="py-lineno">169</tt>  <tt class="py-line">            <tt id="link-43" class="py-name"><a title="modbus_tk.hooks.call_hooks" class="py-name" href="#" onclick="return doclink('link-43', 'call_hooks', 'link-2');">call_hooks</a></tt><tt class="py-op">(</tt><tt class="py-string">"modbus_tcp.TcpMaster.before_close"</tt><tt class="py-op">,</tt> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L170"></a><tt class="py-lineno">170</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_sock</tt><tt class="py-op">.</tt><tt id="link-44" class="py-name"><a title="modbus_tk.modbus.Master.close
modbus_tk.modbus_rtu.RtuServer.close
modbus_tk.simulator.ConsoleInterface.close
modbus_tk.simulator.RpcInterface.close
modbus_tk.simulator.Simulator.close" class="py-name" href="#" onclick="return doclink('link-44', 'close', 'link-38');">close</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L171"></a><tt class="py-lineno">171</tt>  <tt class="py-line">            <tt id="link-45" class="py-name"><a title="modbus_tk.hooks.call_hooks" class="py-name" href="#" onclick="return doclink('link-45', 'call_hooks', 'link-2');">call_hooks</a></tt><tt class="py-op">(</tt><tt class="py-string">"modbus_tcp.TcpMaster.after_close"</tt><tt class="py-op">,</tt> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L172"></a><tt class="py-lineno">172</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_sock</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
</div><a name="L173"></a><tt class="py-lineno">173</tt>  <tt class="py-line">     </tt>
<a name="TcpMaster.set_timeout"></a><div id="TcpMaster.set_timeout-def"><a name="L174"></a><tt class="py-lineno">174</tt> <a class="py-toggle" href="#" id="TcpMaster.set_timeout-toggle" onclick="return toggle('TcpMaster.set_timeout');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus_tcp.TcpMaster-class.html#set_timeout">set_timeout</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">timeout_in_sec</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="TcpMaster.set_timeout-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="TcpMaster.set_timeout-expanded"><a name="L175"></a><tt class="py-lineno">175</tt>  <tt class="py-line">        <tt class="py-docstring">"""Change the timeout value"""</tt> </tt>
<a name="L176"></a><tt class="py-lineno">176</tt>  <tt class="py-line">        <tt id="link-46" class="py-name"><a title="modbus_tk.modbus.Master" class="py-name" href="#" onclick="return doclink('link-46', 'Master', 'link-36');">Master</a></tt><tt class="py-op">.</tt><tt id="link-47" class="py-name"><a title="modbus_tk.modbus.Master.set_timeout
modbus_tk.modbus_rtu.RtuMaster.set_timeout
modbus_tk.modbus_tcp.TcpMaster.set_timeout" class="py-name" href="#" onclick="return doclink('link-47', 'set_timeout', 'link-39');">set_timeout</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-name">timeout_in_sec</tt><tt class="py-op">)</tt> </tt>
<a name="L177"></a><tt class="py-lineno">177</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_sock</tt><tt class="py-op">:</tt> </tt>
<a name="L178"></a><tt class="py-lineno">178</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_sock</tt><tt class="py-op">.</tt><tt class="py-name">setblocking</tt><tt class="py-op">(</tt><tt class="py-name">timeout_in_sec</tt><tt class="py-op">&gt;</tt><tt class="py-number">0</tt><tt class="py-op">)</tt> </tt>
<a name="L179"></a><tt class="py-lineno">179</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-name">timeout_in_sec</tt><tt class="py-op">:</tt> </tt>
<a name="L180"></a><tt class="py-lineno">180</tt>  <tt class="py-line">                <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_sock</tt><tt class="py-op">.</tt><tt class="py-name">settimeout</tt><tt class="py-op">(</tt><tt class="py-name">timeout_in_sec</tt><tt class="py-op">)</tt>         </tt>
</div><a name="L181"></a><tt class="py-lineno">181</tt>  <tt class="py-line">         </tt>
<a name="TcpMaster._send"></a><div id="TcpMaster._send-def"><a name="L182"></a><tt class="py-lineno">182</tt> <a class="py-toggle" href="#" id="TcpMaster._send-toggle" onclick="return toggle('TcpMaster._send');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus_tcp.TcpMaster-class.html#_send">_send</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">request</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="TcpMaster._send-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="TcpMaster._send-expanded"><a name="L183"></a><tt class="py-lineno">183</tt>  <tt class="py-line">        <tt class="py-docstring">"""Send request to the slave"""</tt> </tt>
<a name="L184"></a><tt class="py-lineno">184</tt>  <tt class="py-line">        <tt class="py-name">retval</tt> <tt class="py-op">=</tt> <tt id="link-48" class="py-name"><a title="modbus_tk.hooks.call_hooks" class="py-name" href="#" onclick="return doclink('link-48', 'call_hooks', 'link-2');">call_hooks</a></tt><tt class="py-op">(</tt><tt class="py-string">"modbus_tcp.TcpMaster.before_send"</tt><tt class="py-op">,</tt> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-name">request</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L185"></a><tt class="py-lineno">185</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">retval</tt> <tt class="py-op">&lt;&gt;</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L186"></a><tt class="py-lineno">186</tt>  <tt class="py-line">            <tt class="py-name">request</tt> <tt class="py-op">=</tt> <tt class="py-name">retval</tt> </tt>
<a name="L187"></a><tt class="py-lineno">187</tt>  <tt class="py-line">        <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L188"></a><tt class="py-lineno">188</tt>  <tt class="py-line">            <tt id="link-49" class="py-name"><a title="modbus_tk.utils" class="py-name" href="#" onclick="return doclink('link-49', 'utils', 'link-3');">utils</a></tt><tt class="py-op">.</tt><tt id="link-50" class="py-name" targets="Function modbus_tk.utils.flush_socket()=modbus_tk.utils-module.html#flush_socket"><a title="modbus_tk.utils.flush_socket" class="py-name" href="#" onclick="return doclink('link-50', 'flush_socket', 'link-50');">flush_socket</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_sock</tt><tt class="py-op">,</tt> <tt class="py-number">3</tt><tt class="py-op">)</tt> </tt>
<a name="L189"></a><tt class="py-lineno">189</tt>  <tt class="py-line">        <tt class="py-keyword">except</tt> <tt class="py-name">Exception</tt><tt class="py-op">,</tt> <tt class="py-name">msg</tt><tt class="py-op">:</tt> </tt>
<a name="L190"></a><tt class="py-lineno">190</tt>  <tt class="py-line">            <tt class="py-comment">#if we can't flush the socket successfully: a disconnection may happened</tt> </tt>
<a name="L191"></a><tt class="py-lineno">191</tt>  <tt class="py-line">            <tt class="py-comment">#try to reconnect</tt> </tt>
<a name="L192"></a><tt class="py-lineno">192</tt>  <tt class="py-line">            <tt id="link-51" class="py-name" targets="Variable modbus_tk.modbus.LOGGER=modbus_tk.modbus-module.html#LOGGER,Variable modbus_tk.modbus_rtu.LOGGER=modbus_tk.modbus_rtu-module.html#LOGGER,Variable modbus_tk.modbus_tcp.LOGGER=modbus_tk.modbus_tcp-module.html#LOGGER,Variable modbus_tk.simulator.LOGGER=modbus_tk.simulator-module.html#LOGGER"><a title="modbus_tk.modbus.LOGGER
modbus_tk.modbus_rtu.LOGGER
modbus_tk.modbus_tcp.LOGGER
modbus_tk.simulator.LOGGER" class="py-name" href="#" onclick="return doclink('link-51', 'LOGGER', 'link-51');">LOGGER</a></tt><tt class="py-op">.</tt><tt class="py-name">error</tt><tt class="py-op">(</tt><tt class="py-string">'Error while flushing the socket: {0}'</tt><tt class="py-op">.</tt><tt class="py-name">format</tt><tt class="py-op">(</tt><tt class="py-name">msg</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L193"></a><tt class="py-lineno">193</tt>  <tt class="py-line">            <tt class="py-keyword">raise</tt> <tt id="link-52" class="py-name" targets="Class modbus_tk.modbus.ModbusNotConnectedError=modbus_tk.modbus.ModbusNotConnectedError-class.html"><a title="modbus_tk.modbus.ModbusNotConnectedError" class="py-name" href="#" onclick="return doclink('link-52', 'ModbusNotConnectedError', 'link-52');">ModbusNotConnectedError</a></tt><tt class="py-op">(</tt><tt class="py-name">msg</tt><tt class="py-op">)</tt> </tt>
<a name="L194"></a><tt class="py-lineno">194</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_sock</tt><tt class="py-op">.</tt><tt class="py-name">send</tt><tt class="py-op">(</tt><tt class="py-name">request</tt><tt class="py-op">)</tt> </tt>
</div><a name="L195"></a><tt class="py-lineno">195</tt>  <tt class="py-line">         </tt>
<a name="TcpMaster._recv"></a><div id="TcpMaster._recv-def"><a name="L196"></a><tt class="py-lineno">196</tt> <a class="py-toggle" href="#" id="TcpMaster._recv-toggle" onclick="return toggle('TcpMaster._recv');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus_tcp.TcpMaster-class.html#_recv">_recv</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">expected_length</tt><tt class="py-op">=</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="TcpMaster._recv-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="TcpMaster._recv-expanded"><a name="L197"></a><tt class="py-lineno">197</tt>  <tt class="py-line">        <tt class="py-docstring">"""</tt> </tt>
<a name="L198"></a><tt class="py-lineno">198</tt>  <tt class="py-line"><tt class="py-docstring">        Receive the response from the slave</tt> </tt>
<a name="L199"></a><tt class="py-lineno">199</tt>  <tt class="py-line"><tt class="py-docstring">        Do not take expected_length into account because the length of the response is</tt> </tt>
<a name="L200"></a><tt class="py-lineno">200</tt>  <tt class="py-line"><tt class="py-docstring">        written in the mbap. Used for RTU only</tt> </tt>
<a name="L201"></a><tt class="py-lineno">201</tt>  <tt class="py-line"><tt class="py-docstring">        """</tt> </tt>
<a name="L202"></a><tt class="py-lineno">202</tt>  <tt class="py-line">         </tt>
<a name="L203"></a><tt class="py-lineno">203</tt>  <tt class="py-line">        <tt class="py-name">response</tt> <tt class="py-op">=</tt> <tt class="py-string">""</tt> </tt>
<a name="L204"></a><tt class="py-lineno">204</tt>  <tt class="py-line">        <tt class="py-name">length</tt> <tt class="py-op">=</tt> <tt class="py-number">255</tt> </tt>
<a name="L205"></a><tt class="py-lineno">205</tt>  <tt class="py-line">        <tt class="py-keyword">while</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">response</tt><tt class="py-op">)</tt><tt class="py-op">&lt;</tt><tt class="py-name">length</tt><tt class="py-op">:</tt> </tt>
<a name="L206"></a><tt class="py-lineno">206</tt>  <tt class="py-line">            <tt class="py-name">rcv_byte</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_sock</tt><tt class="py-op">.</tt><tt class="py-name">recv</tt><tt class="py-op">(</tt><tt class="py-number">1</tt><tt class="py-op">)</tt> </tt>
<a name="L207"></a><tt class="py-lineno">207</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-name">rcv_byte</tt><tt class="py-op">:</tt> </tt>
<a name="L208"></a><tt class="py-lineno">208</tt>  <tt class="py-line">                <tt class="py-name">response</tt> <tt class="py-op">+=</tt> <tt class="py-name">rcv_byte</tt> </tt>
<a name="L209"></a><tt class="py-lineno">209</tt>  <tt class="py-line">                <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">response</tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> <tt class="py-number">6</tt><tt class="py-op">:</tt> </tt>
<a name="L210"></a><tt class="py-lineno">210</tt>  <tt class="py-line">                    <tt class="py-op">(</tt><tt class="py-name">tr_id</tt><tt class="py-op">,</tt> <tt class="py-name">pr_id</tt><tt class="py-op">,</tt> <tt class="py-name">to_be_recv_length</tt><tt class="py-op">)</tt> <tt class="py-op">=</tt> <tt class="py-name">struct</tt><tt class="py-op">.</tt><tt id="link-53" class="py-name"><a title="modbus_tk.modbus_tcp.TcpMbap.unpack" class="py-name" href="#" onclick="return doclink('link-53', 'unpack', 'link-10');">unpack</a></tt><tt class="py-op">(</tt><tt class="py-string">"&gt;HHH"</tt><tt class="py-op">,</tt> <tt class="py-name">response</tt><tt class="py-op">)</tt> </tt>
<a name="L211"></a><tt class="py-lineno">211</tt>  <tt class="py-line">                    <tt class="py-name">length</tt> <tt class="py-op">=</tt> <tt class="py-name">to_be_recv_length</tt> <tt class="py-op">+</tt> <tt class="py-number">6</tt> </tt>
<a name="L212"></a><tt class="py-lineno">212</tt>  <tt class="py-line">            <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L213"></a><tt class="py-lineno">213</tt>  <tt class="py-line">                <tt class="py-keyword">break</tt> </tt>
<a name="L214"></a><tt class="py-lineno">214</tt>  <tt class="py-line">        <tt class="py-name">retval</tt> <tt class="py-op">=</tt> <tt id="link-54" class="py-name"><a title="modbus_tk.hooks.call_hooks" class="py-name" href="#" onclick="return doclink('link-54', 'call_hooks', 'link-2');">call_hooks</a></tt><tt class="py-op">(</tt><tt class="py-string">"modbus_tcp.TcpMaster.after_recv"</tt><tt class="py-op">,</tt> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-name">response</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L215"></a><tt class="py-lineno">215</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">retval</tt> <tt class="py-op">&lt;&gt;</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L216"></a><tt class="py-lineno">216</tt>  <tt class="py-line">            <tt class="py-keyword">return</tt> <tt class="py-name">response</tt> </tt>
<a name="L217"></a><tt class="py-lineno">217</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">response</tt> </tt>
</div><a name="L218"></a><tt class="py-lineno">218</tt>  <tt class="py-line">         </tt>
<a name="TcpMaster._make_query"></a><div id="TcpMaster._make_query-def"><a name="L219"></a><tt class="py-lineno">219</tt> <a class="py-toggle" href="#" id="TcpMaster._make_query-toggle" onclick="return toggle('TcpMaster._make_query');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus_tcp.TcpMaster-class.html#_make_query">_make_query</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="TcpMaster._make_query-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="TcpMaster._make_query-expanded"><a name="L220"></a><tt class="py-lineno">220</tt>  <tt class="py-line">        <tt class="py-docstring">"""Returns an instance of a Query subclass implementing the modbus TCP protocol"""</tt> </tt>
<a name="L221"></a><tt class="py-lineno">221</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt id="link-55" class="py-name"><a title="modbus_tk.modbus_tcp.TcpQuery" class="py-name" href="#" onclick="return doclink('link-55', 'TcpQuery', 'link-16');">TcpQuery</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L222"></a><tt class="py-lineno">222</tt>  <tt class="py-line"> </tt>
<a name="TcpServer"></a><div id="TcpServer-def"><a name="L223"></a><tt class="py-lineno">223</tt>  <tt class="py-line"><tt class="py-comment">#-------------------------------------------------------------------------------</tt> </tt>
<a name="L224"></a><tt class="py-lineno">224</tt> <a class="py-toggle" href="#" id="TcpServer-toggle" onclick="return toggle('TcpServer');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="modbus_tk.modbus_tcp.TcpServer-class.html">TcpServer</a><tt class="py-op">(</tt><tt class="py-base-class">Server</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="TcpServer-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="TcpServer-expanded"><a name="L225"></a><tt class="py-lineno">225</tt>  <tt class="py-line">    <tt class="py-docstring">"""This class implements a simple and mono-threaded modbus tcp server"""</tt> </tt>
<a name="L226"></a><tt class="py-lineno">226</tt>  <tt class="py-line">     </tt>
<a name="TcpServer.__init__"></a><div id="TcpServer.__init__-def"><a name="L227"></a><tt class="py-lineno">227</tt> <a class="py-toggle" href="#" id="TcpServer.__init__-toggle" onclick="return toggle('TcpServer.__init__');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus_tcp.TcpServer-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">port</tt><tt class="py-op">=</tt><tt class="py-number">502</tt><tt class="py-op">,</tt> <tt class="py-param">address</tt><tt class="py-op">=</tt><tt class="py-string">'localhost'</tt><tt class="py-op">,</tt> <tt class="py-param">timeout_in_sec</tt><tt class="py-op">=</tt><tt class="py-number">1</tt><tt class="py-op">,</tt> <tt class="py-param">databank</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="TcpServer.__init__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="TcpServer.__init__-expanded"><a name="L228"></a><tt class="py-lineno">228</tt>  <tt class="py-line">        <tt class="py-docstring">"""Constructor: initializes the server settings"""</tt> </tt>
<a name="L229"></a><tt class="py-lineno">229</tt>  <tt class="py-line">        <tt id="link-56" class="py-name" targets="Class modbus_tk.modbus.Server=modbus_tk.modbus.Server-class.html"><a title="modbus_tk.modbus.Server" class="py-name" href="#" onclick="return doclink('link-56', 'Server', 'link-56');">Server</a></tt><tt class="py-op">.</tt><tt id="link-57" class="py-name"><a title="modbus_tk.modbus.Databank.__init__
modbus_tk.modbus.Master.__init__
modbus_tk.modbus.ModbusBlock.__init__
modbus_tk.modbus.ModbusError.__init__
modbus_tk.modbus.Query.__init__
modbus_tk.modbus.Server.__init__
modbus_tk.modbus.Slave.__init__
modbus_tk.modbus_rtu.RtuMaster.__init__
modbus_tk.modbus_rtu.RtuQuery.__init__
modbus_tk.modbus_rtu.RtuServer.__init__
modbus_tk.modbus_tcp.ModbusInvalidMbapError.__init__
modbus_tk.modbus_tcp.TcpMaster.__init__
modbus_tk.modbus_tcp.TcpMbap.__init__
modbus_tk.modbus_tcp.TcpQuery.__init__
modbus_tk.modbus_tcp.TcpServer.__init__
modbus_tk.simulator.CompositeServer.__init__
modbus_tk.simulator.ConsoleInterface.__init__
modbus_tk.simulator.RpcInterface.__init__
modbus_tk.simulator.Simulator.__init__
modbus_tk.simulator_rpc_client.SimulatorRpcClient.__init__
modbus_tk.utils.ConsoleHandler.__init__
modbus_tk.utils.DummyHandler.__init__
modbus_tk.utils.LogitHandler.__init__
modbus_tk.utils.WorkerThread.__init__" class="py-name" href="#" onclick="return doclink('link-57', '__init__', 'link-5');">__init__</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-name">databank</tt> <tt class="py-keyword">if</tt> <tt class="py-name">databank</tt> <tt class="py-keyword">else</tt> <tt id="link-58" class="py-name" targets="Class modbus_tk.modbus.Databank=modbus_tk.modbus.Databank-class.html"><a title="modbus_tk.modbus.Databank" class="py-name" href="#" onclick="return doclink('link-58', 'Databank', 'link-58');">Databank</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L230"></a><tt class="py-lineno">230</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_sock</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L231"></a><tt class="py-lineno">231</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_sa</tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-name">address</tt><tt class="py-op">,</tt> <tt class="py-name">port</tt><tt class="py-op">)</tt> </tt>
<a name="L232"></a><tt class="py-lineno">232</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_timeout_in_sec</tt> <tt class="py-op">=</tt> <tt class="py-name">timeout_in_sec</tt> </tt>
<a name="L233"></a><tt class="py-lineno">233</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_sockets</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
</div><a name="L234"></a><tt class="py-lineno">234</tt>  <tt class="py-line">                </tt>
<a name="TcpServer._make_query"></a><div id="TcpServer._make_query-def"><a name="L235"></a><tt class="py-lineno">235</tt> <a class="py-toggle" href="#" id="TcpServer._make_query-toggle" onclick="return toggle('TcpServer._make_query');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus_tcp.TcpServer-class.html#_make_query">_make_query</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="TcpServer._make_query-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="TcpServer._make_query-expanded"><a name="L236"></a><tt class="py-lineno">236</tt>  <tt class="py-line">        <tt class="py-docstring">"""Returns an instance of a Query subclass implementing the modbus TCP protocol"""</tt> </tt>
<a name="L237"></a><tt class="py-lineno">237</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt id="link-59" class="py-name"><a title="modbus_tk.modbus_tcp.TcpQuery" class="py-name" href="#" onclick="return doclink('link-59', 'TcpQuery', 'link-16');">TcpQuery</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L238"></a><tt class="py-lineno">238</tt>  <tt class="py-line">     </tt>
<a name="TcpServer._get_request_length"></a><div id="TcpServer._get_request_length-def"><a name="L239"></a><tt class="py-lineno">239</tt> <a class="py-toggle" href="#" id="TcpServer._get_request_length-toggle" onclick="return toggle('TcpServer._get_request_length');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus_tcp.TcpServer-class.html#_get_request_length">_get_request_length</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">mbap</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="TcpServer._get_request_length-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="TcpServer._get_request_length-expanded"><a name="L240"></a><tt class="py-lineno">240</tt>  <tt class="py-line">        <tt class="py-docstring">"""Parse the mbap and returns the number of bytes to be read"""</tt> </tt>
<a name="L241"></a><tt class="py-lineno">241</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">mbap</tt><tt class="py-op">)</tt> <tt class="py-op">&lt;</tt> <tt class="py-number">6</tt><tt class="py-op">:</tt> </tt>
<a name="L242"></a><tt class="py-lineno">242</tt>  <tt class="py-line">            <tt class="py-keyword">raise</tt> <tt id="link-60" class="py-name"><a title="modbus_tk.modbus.ModbusInvalidRequestError" class="py-name" href="#" onclick="return doclink('link-60', 'ModbusInvalidRequestError', 'link-33');">ModbusInvalidRequestError</a></tt><tt class="py-op">(</tt><tt class="py-string">"The mbap is only %d bytes long"</tt><tt class="py-op">,</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">mbap</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L243"></a><tt class="py-lineno">243</tt>  <tt class="py-line">        <tt class="py-op">(</tt><tt class="py-name">tr_id</tt><tt class="py-op">,</tt> <tt class="py-name">pr_id</tt><tt class="py-op">,</tt> <tt class="py-name">length</tt><tt class="py-op">)</tt> <tt class="py-op">=</tt> <tt class="py-name">struct</tt><tt class="py-op">.</tt><tt id="link-61" class="py-name"><a title="modbus_tk.modbus_tcp.TcpMbap.unpack" class="py-name" href="#" onclick="return doclink('link-61', 'unpack', 'link-10');">unpack</a></tt><tt class="py-op">(</tt><tt class="py-string">"&gt;HHH"</tt><tt class="py-op">,</tt> <tt class="py-name">mbap</tt><tt class="py-op">[</tt><tt class="py-op">:</tt><tt class="py-number">6</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L244"></a><tt class="py-lineno">244</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">length</tt> </tt>
</div><a name="L245"></a><tt class="py-lineno">245</tt>  <tt class="py-line"> </tt>
<a name="TcpServer._do_init"></a><div id="TcpServer._do_init-def"><a name="L246"></a><tt class="py-lineno">246</tt> <a class="py-toggle" href="#" id="TcpServer._do_init-toggle" onclick="return toggle('TcpServer._do_init');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus_tcp.TcpServer-class.html#_do_init">_do_init</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="TcpServer._do_init-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="TcpServer._do_init-expanded"><a name="L247"></a><tt class="py-lineno">247</tt>  <tt class="py-line">        <tt class="py-docstring">"""initialize server"""</tt> </tt>
<a name="L248"></a><tt class="py-lineno">248</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_sock</tt> <tt class="py-op">=</tt> <tt class="py-name">socket</tt><tt class="py-op">.</tt><tt class="py-name">socket</tt><tt class="py-op">(</tt><tt class="py-name">socket</tt><tt class="py-op">.</tt><tt class="py-name">AF_INET</tt><tt class="py-op">,</tt> <tt class="py-name">socket</tt><tt class="py-op">.</tt><tt class="py-name">SOCK_STREAM</tt><tt class="py-op">)</tt> </tt>
<a name="L249"></a><tt class="py-lineno">249</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_timeout_in_sec</tt><tt class="py-op">:</tt> </tt>
<a name="L250"></a><tt class="py-lineno">250</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_sock</tt><tt class="py-op">.</tt><tt class="py-name">settimeout</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_timeout_in_sec</tt><tt class="py-op">)</tt> </tt>
<a name="L251"></a><tt class="py-lineno">251</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_sock</tt><tt class="py-op">.</tt><tt class="py-name">setblocking</tt><tt class="py-op">(</tt><tt class="py-number">0</tt><tt class="py-op">)</tt> </tt>
<a name="L252"></a><tt class="py-lineno">252</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_sock</tt><tt class="py-op">.</tt><tt class="py-name">bind</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_sa</tt><tt class="py-op">)</tt> </tt>
<a name="L253"></a><tt class="py-lineno">253</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_sock</tt><tt class="py-op">.</tt><tt class="py-name">listen</tt><tt class="py-op">(</tt><tt class="py-number">10</tt><tt class="py-op">)</tt> </tt>
<a name="L254"></a><tt class="py-lineno">254</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_sockets</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_sock</tt><tt class="py-op">)</tt> </tt>
</div><a name="L255"></a><tt class="py-lineno">255</tt>  <tt class="py-line">         </tt>
<a name="TcpServer._do_exit"></a><div id="TcpServer._do_exit-def"><a name="L256"></a><tt class="py-lineno">256</tt> <a class="py-toggle" href="#" id="TcpServer._do_exit-toggle" onclick="return toggle('TcpServer._do_exit');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus_tcp.TcpServer-class.html#_do_exit">_do_exit</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="TcpServer._do_exit-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="TcpServer._do_exit-expanded"><a name="L257"></a><tt class="py-lineno">257</tt>  <tt class="py-line">        <tt class="py-docstring">"""clean the server tasks"""</tt> </tt>
<a name="L258"></a><tt class="py-lineno">258</tt>  <tt class="py-line">        <tt class="py-comment">#close the sockets</tt> </tt>
<a name="L259"></a><tt class="py-lineno">259</tt>  <tt class="py-line">        <tt class="py-keyword">for</tt> <tt class="py-name">sock</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_sockets</tt><tt class="py-op">:</tt> </tt>
<a name="L260"></a><tt class="py-lineno">260</tt>  <tt class="py-line">            <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L261"></a><tt class="py-lineno">261</tt>  <tt class="py-line">                <tt class="py-name">sock</tt><tt class="py-op">.</tt><tt id="link-62" class="py-name"><a title="modbus_tk.modbus.Master.close
modbus_tk.modbus_rtu.RtuServer.close
modbus_tk.simulator.ConsoleInterface.close
modbus_tk.simulator.RpcInterface.close
modbus_tk.simulator.Simulator.close" class="py-name" href="#" onclick="return doclink('link-62', 'close', 'link-38');">close</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L262"></a><tt class="py-lineno">262</tt>  <tt class="py-line">                <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_sockets</tt><tt class="py-op">.</tt><tt class="py-name">remove</tt><tt class="py-op">(</tt><tt class="py-name">sock</tt><tt class="py-op">)</tt> </tt>
<a name="L263"></a><tt class="py-lineno">263</tt>  <tt class="py-line">            <tt class="py-keyword">except</tt> <tt class="py-name">Exception</tt><tt class="py-op">,</tt> <tt class="py-name">msg</tt><tt class="py-op">:</tt> </tt>
<a name="L264"></a><tt class="py-lineno">264</tt>  <tt class="py-line">                <tt id="link-63" class="py-name"><a title="modbus_tk.modbus.LOGGER
modbus_tk.modbus_rtu.LOGGER
modbus_tk.modbus_tcp.LOGGER
modbus_tk.simulator.LOGGER" class="py-name" href="#" onclick="return doclink('link-63', 'LOGGER', 'link-51');">LOGGER</a></tt><tt class="py-op">.</tt><tt class="py-name">warning</tt><tt class="py-op">(</tt><tt class="py-string">"Error while closing socket, Exception occurred: %s"</tt><tt class="py-op">,</tt> <tt class="py-name">msg</tt><tt class="py-op">)</tt> </tt>
<a name="L265"></a><tt class="py-lineno">265</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_sock</tt><tt class="py-op">.</tt><tt id="link-64" class="py-name"><a title="modbus_tk.modbus.Master.close
modbus_tk.modbus_rtu.RtuServer.close
modbus_tk.simulator.ConsoleInterface.close
modbus_tk.simulator.RpcInterface.close
modbus_tk.simulator.Simulator.close" class="py-name" href="#" onclick="return doclink('link-64', 'close', 'link-38');">close</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L266"></a><tt class="py-lineno">266</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_sock</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt>     </tt>
</div><a name="L267"></a><tt class="py-lineno">267</tt>  <tt class="py-line">    </tt>
<a name="TcpServer._do_run"></a><div id="TcpServer._do_run-def"><a name="L268"></a><tt class="py-lineno">268</tt> <a class="py-toggle" href="#" id="TcpServer._do_run-toggle" onclick="return toggle('TcpServer._do_run');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="modbus_tk.modbus_tcp.TcpServer-class.html#_do_run">_do_run</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="TcpServer._do_run-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="TcpServer._do_run-expanded"><a name="L269"></a><tt class="py-lineno">269</tt>  <tt class="py-line">        <tt class="py-docstring">"""called in a almost-for-ever loop by the server"""</tt> </tt>
<a name="L270"></a><tt class="py-lineno">270</tt>  <tt class="py-line">        <tt class="py-comment">#check the status of every socket</tt> </tt>
<a name="L271"></a><tt class="py-lineno">271</tt>  <tt class="py-line">        <tt class="py-name">inputready</tt><tt class="py-op">,</tt> <tt class="py-name">outputready</tt><tt class="py-op">,</tt> <tt class="py-name">exceptready</tt> <tt class="py-op">=</tt> <tt class="py-name">select</tt><tt class="py-op">.</tt><tt class="py-name">select</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_sockets</tt><tt class="py-op">,</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-number">1.0</tt><tt class="py-op">)</tt> </tt>
<a name="L272"></a><tt class="py-lineno">272</tt>  <tt class="py-line"> </tt>
<a name="L273"></a><tt class="py-lineno">273</tt>  <tt class="py-line">        <tt class="py-keyword">for</tt> <tt class="py-name">sock</tt> <tt class="py-keyword">in</tt> <tt class="py-name">inputready</tt><tt class="py-op">:</tt> <tt class="py-comment">#handle data on each a socket</tt> </tt>
<a name="L274"></a><tt class="py-lineno">274</tt>  <tt class="py-line">            <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L275"></a><tt class="py-lineno">275</tt>  <tt class="py-line">                <tt class="py-keyword">if</tt> <tt class="py-name">sock</tt> <tt class="py-op">==</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_sock</tt><tt class="py-op">:</tt> </tt>
<a name="L276"></a><tt class="py-lineno">276</tt>  <tt class="py-line">                    <tt class="py-comment"># handle the server socket</tt> </tt>
<a name="L277"></a><tt class="py-lineno">277</tt>  <tt class="py-line">                    <tt class="py-name">client</tt><tt class="py-op">,</tt> <tt class="py-name">address</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_sock</tt><tt class="py-op">.</tt><tt class="py-name">accept</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L278"></a><tt class="py-lineno">278</tt>  <tt class="py-line">                    <tt class="py-name">client</tt><tt class="py-op">.</tt><tt class="py-name">setblocking</tt><tt class="py-op">(</tt><tt class="py-number">0</tt><tt class="py-op">)</tt> </tt>
<a name="L279"></a><tt class="py-lineno">279</tt>  <tt class="py-line">                    <tt id="link-65" class="py-name"><a title="modbus_tk.modbus.LOGGER
modbus_tk.modbus_rtu.LOGGER
modbus_tk.modbus_tcp.LOGGER
modbus_tk.simulator.LOGGER" class="py-name" href="#" onclick="return doclink('link-65', 'LOGGER', 'link-51');">LOGGER</a></tt><tt class="py-op">.</tt><tt class="py-name">info</tt><tt class="py-op">(</tt><tt class="py-string">"%s is connected with socket %d..."</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">address</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">client</tt><tt class="py-op">.</tt><tt class="py-name">fileno</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L280"></a><tt class="py-lineno">280</tt>  <tt class="py-line">                    <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_sockets</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">client</tt><tt class="py-op">)</tt> </tt>
<a name="L281"></a><tt class="py-lineno">281</tt>  <tt class="py-line">                    <tt id="link-66" class="py-name"><a title="modbus_tk.hooks.call_hooks" class="py-name" href="#" onclick="return doclink('link-66', 'call_hooks', 'link-2');">call_hooks</a></tt><tt class="py-op">(</tt><tt class="py-string">"modbus_tcp.TcpServer.on_connect"</tt><tt class="py-op">,</tt> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-name">client</tt><tt class="py-op">,</tt> <tt class="py-name">address</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L282"></a><tt class="py-lineno">282</tt>  <tt class="py-line">                <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L283"></a><tt class="py-lineno">283</tt>  <tt class="py-line">                    <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">sock</tt><tt class="py-op">.</tt><tt class="py-name">recv</tt><tt class="py-op">(</tt><tt class="py-number">1</tt><tt class="py-op">,</tt> <tt class="py-name">socket</tt><tt class="py-op">.</tt><tt class="py-name">MSG_PEEK</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> <tt class="py-number">0</tt><tt class="py-op">:</tt> </tt>
<a name="L284"></a><tt class="py-lineno">284</tt>  <tt class="py-line">                        <tt class="py-comment">#socket is disconnected</tt> </tt>
<a name="L285"></a><tt class="py-lineno">285</tt>  <tt class="py-line">                        <tt id="link-67" class="py-name"><a title="modbus_tk.modbus.LOGGER
modbus_tk.modbus_rtu.LOGGER
modbus_tk.modbus_tcp.LOGGER
modbus_tk.simulator.LOGGER" class="py-name" href="#" onclick="return doclink('link-67', 'LOGGER', 'link-51');">LOGGER</a></tt><tt class="py-op">.</tt><tt class="py-name">info</tt><tt class="py-op">(</tt><tt class="py-string">"%d is disconnected"</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">sock</tt><tt class="py-op">.</tt><tt class="py-name">fileno</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L286"></a><tt class="py-lineno">286</tt>  <tt class="py-line">                        <tt id="link-68" class="py-name"><a title="modbus_tk.hooks.call_hooks" class="py-name" href="#" onclick="return doclink('link-68', 'call_hooks', 'link-2');">call_hooks</a></tt><tt class="py-op">(</tt><tt class="py-string">"modbus_tcp.TcpServer.on_disconnect"</tt><tt class="py-op">,</tt> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-name">sock</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L287"></a><tt class="py-lineno">287</tt>  <tt class="py-line">                        <tt class="py-name">sock</tt><tt class="py-op">.</tt><tt id="link-69" class="py-name"><a title="modbus_tk.modbus.Master.close
modbus_tk.modbus_rtu.RtuServer.close
modbus_tk.simulator.ConsoleInterface.close
modbus_tk.simulator.RpcInterface.close
modbus_tk.simulator.Simulator.close" class="py-name" href="#" onclick="return doclink('link-69', 'close', 'link-38');">close</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L288"></a><tt class="py-lineno">288</tt>  <tt class="py-line">                        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_sockets</tt><tt class="py-op">.</tt><tt class="py-name">remove</tt><tt class="py-op">(</tt><tt class="py-name">sock</tt><tt class="py-op">)</tt> </tt>
<a name="L289"></a><tt class="py-lineno">289</tt>  <tt class="py-line">                        <tt class="py-keyword">break</tt> </tt>
<a name="L290"></a><tt class="py-lineno">290</tt>  <tt class="py-line">                     </tt>
<a name="L291"></a><tt class="py-lineno">291</tt>  <tt class="py-line">                    <tt class="py-comment"># handle all other sockets</tt> </tt>
<a name="L292"></a><tt class="py-lineno">292</tt>  <tt class="py-line">                    <tt class="py-name">sock</tt><tt class="py-op">.</tt><tt class="py-name">settimeout</tt><tt class="py-op">(</tt><tt class="py-number">1.0</tt><tt class="py-op">)</tt> </tt>
<a name="L293"></a><tt class="py-lineno">293</tt>  <tt class="py-line">                    <tt class="py-name">request</tt> <tt class="py-op">=</tt> <tt class="py-string">""</tt> </tt>
<a name="L294"></a><tt class="py-lineno">294</tt>  <tt class="py-line">                    <tt class="py-name">is_ok</tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt> </tt>
<a name="L295"></a><tt class="py-lineno">295</tt>  <tt class="py-line">                     </tt>
<a name="L296"></a><tt class="py-lineno">296</tt>  <tt class="py-line">                    <tt class="py-comment">#read the 7 bytes of the mbap</tt> </tt>
<a name="L297"></a><tt class="py-lineno">297</tt>  <tt class="py-line">                    <tt class="py-keyword">while</tt> <tt class="py-op">(</tt><tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">request</tt><tt class="py-op">)</tt> <tt class="py-op">&lt;</tt> <tt class="py-number">7</tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> <tt class="py-name">is_ok</tt><tt class="py-op">:</tt>  </tt>
<a name="L298"></a><tt class="py-lineno">298</tt>  <tt class="py-line">                        <tt class="py-name">new_byte</tt> <tt class="py-op">=</tt> <tt class="py-name">sock</tt><tt class="py-op">.</tt><tt class="py-name">recv</tt><tt class="py-op">(</tt><tt class="py-number">1</tt><tt class="py-op">)</tt> </tt>
<a name="L299"></a><tt class="py-lineno">299</tt>  <tt class="py-line">                        <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">new_byte</tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> <tt class="py-number">0</tt><tt class="py-op">:</tt> </tt>
<a name="L300"></a><tt class="py-lineno">300</tt>  <tt class="py-line">                            <tt class="py-name">is_ok</tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt>     </tt>
<a name="L301"></a><tt class="py-lineno">301</tt>  <tt class="py-line">                        <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L302"></a><tt class="py-lineno">302</tt>  <tt class="py-line">                            <tt class="py-name">request</tt> <tt class="py-op">+=</tt> <tt class="py-name">new_byte</tt> </tt>
<a name="L303"></a><tt class="py-lineno">303</tt>  <tt class="py-line">                         </tt>
<a name="L304"></a><tt class="py-lineno">304</tt>  <tt class="py-line">                    <tt class="py-name">retval</tt> <tt class="py-op">=</tt> <tt id="link-70" class="py-name"><a title="modbus_tk.hooks.call_hooks" class="py-name" href="#" onclick="return doclink('link-70', 'call_hooks', 'link-2');">call_hooks</a></tt><tt class="py-op">(</tt><tt class="py-string">"modbus_tcp.TcpServer.after_recv"</tt><tt class="py-op">,</tt> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-name">sock</tt><tt class="py-op">,</tt> <tt class="py-name">request</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L305"></a><tt class="py-lineno">305</tt>  <tt class="py-line">                    <tt class="py-keyword">if</tt> <tt class="py-name">retval</tt> <tt class="py-op">&lt;&gt;</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L306"></a><tt class="py-lineno">306</tt>  <tt class="py-line">                        <tt class="py-name">request</tt> <tt class="py-op">=</tt> <tt class="py-name">retval</tt> </tt>
<a name="L307"></a><tt class="py-lineno">307</tt>  <tt class="py-line">                     </tt>
<a name="L308"></a><tt class="py-lineno">308</tt>  <tt class="py-line">                    <tt class="py-keyword">if</tt> <tt class="py-name">is_ok</tt><tt class="py-op">:</tt> </tt>
<a name="L309"></a><tt class="py-lineno">309</tt>  <tt class="py-line">                        <tt class="py-comment">#read the rest of the request</tt> </tt>
<a name="L310"></a><tt class="py-lineno">310</tt>  <tt class="py-line">                        <tt class="py-name">length</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-71" class="py-name" targets="Method modbus_tk.modbus_tcp.TcpServer._get_request_length()=modbus_tk.modbus_tcp.TcpServer-class.html#_get_request_length"><a title="modbus_tk.modbus_tcp.TcpServer._get_request_length" class="py-name" href="#" onclick="return doclink('link-71', '_get_request_length', 'link-71');">_get_request_length</a></tt><tt class="py-op">(</tt><tt class="py-name">request</tt><tt class="py-op">)</tt> </tt>
<a name="L311"></a><tt class="py-lineno">311</tt>  <tt class="py-line">                        <tt class="py-keyword">while</tt> <tt class="py-op">(</tt><tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">request</tt><tt class="py-op">)</tt> <tt class="py-op">&lt;</tt> <tt class="py-op">(</tt><tt class="py-name">length</tt> <tt class="py-op">+</tt> <tt class="py-number">6</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> <tt class="py-name">is_ok</tt><tt class="py-op">:</tt> </tt>
<a name="L312"></a><tt class="py-lineno">312</tt>  <tt class="py-line">                            <tt class="py-name">new_byte</tt> <tt class="py-op">=</tt> <tt class="py-name">sock</tt><tt class="py-op">.</tt><tt class="py-name">recv</tt><tt class="py-op">(</tt><tt class="py-number">1</tt><tt class="py-op">)</tt> </tt>
<a name="L313"></a><tt class="py-lineno">313</tt>  <tt class="py-line">                            <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">new_byte</tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> <tt class="py-number">0</tt><tt class="py-op">:</tt> </tt>
<a name="L314"></a><tt class="py-lineno">314</tt>  <tt class="py-line">                                <tt class="py-name">is_ok</tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt>
<a name="L315"></a><tt class="py-lineno">315</tt>  <tt class="py-line">                            <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L316"></a><tt class="py-lineno">316</tt>  <tt class="py-line">                                <tt class="py-name">request</tt> <tt class="py-op">+=</tt> <tt class="py-name">new_byte</tt>  </tt>
<a name="L317"></a><tt class="py-lineno">317</tt>  <tt class="py-line">                     </tt>
<a name="L318"></a><tt class="py-lineno">318</tt>  <tt class="py-line">                    <tt class="py-keyword">if</tt> <tt class="py-name">is_ok</tt><tt class="py-op">:</tt> </tt>
<a name="L319"></a><tt class="py-lineno">319</tt>  <tt class="py-line">                        <tt class="py-name">response</tt> <tt class="py-op">=</tt> <tt class="py-string">""</tt> </tt>
<a name="L320"></a><tt class="py-lineno">320</tt>  <tt class="py-line">                        <tt class="py-comment">#parse the request</tt> </tt>
<a name="L321"></a><tt class="py-lineno">321</tt>  <tt class="py-line">                        <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L322"></a><tt class="py-lineno">322</tt>  <tt class="py-line">                            <tt class="py-name">response</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-72" class="py-name" targets="Method modbus_tk.modbus.Server._handle()=modbus_tk.modbus.Server-class.html#_handle,Method modbus_tk.simulator.Simulator._handle()=modbus_tk.simulator.Simulator-class.html#_handle"><a title="modbus_tk.modbus.Server._handle
modbus_tk.simulator.Simulator._handle" class="py-name" href="#" onclick="return doclink('link-72', '_handle', 'link-72');">_handle</a></tt><tt class="py-op">(</tt><tt class="py-name">request</tt><tt class="py-op">)</tt> </tt>
<a name="L323"></a><tt class="py-lineno">323</tt>  <tt class="py-line">                        <tt class="py-keyword">except</tt> <tt class="py-name">Exception</tt><tt class="py-op">,</tt> <tt class="py-name">msg</tt><tt class="py-op">:</tt> </tt>
<a name="L324"></a><tt class="py-lineno">324</tt>  <tt class="py-line">                            <tt id="link-73" class="py-name"><a title="modbus_tk.modbus.LOGGER
modbus_tk.modbus_rtu.LOGGER
modbus_tk.modbus_tcp.LOGGER
modbus_tk.simulator.LOGGER" class="py-name" href="#" onclick="return doclink('link-73', 'LOGGER', 'link-51');">LOGGER</a></tt><tt class="py-op">.</tt><tt class="py-name">error</tt><tt class="py-op">(</tt><tt class="py-string">"Error while handling a request, Exception occurred: %s"</tt><tt class="py-op">,</tt> <tt class="py-name">msg</tt><tt class="py-op">)</tt> </tt>
<a name="L325"></a><tt class="py-lineno">325</tt>  <tt class="py-line">                         </tt>
<a name="L326"></a><tt class="py-lineno">326</tt>  <tt class="py-line">                        <tt class="py-comment">#send back the response</tt> </tt>
<a name="L327"></a><tt class="py-lineno">327</tt>  <tt class="py-line">                        <tt class="py-keyword">if</tt> <tt class="py-name">response</tt><tt class="py-op">:</tt> </tt>
<a name="L328"></a><tt class="py-lineno">328</tt>  <tt class="py-line">                            <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L329"></a><tt class="py-lineno">329</tt>  <tt class="py-line">                                <tt class="py-name">retval</tt> <tt class="py-op">=</tt> <tt id="link-74" class="py-name"><a title="modbus_tk.hooks.call_hooks" class="py-name" href="#" onclick="return doclink('link-74', 'call_hooks', 'link-2');">call_hooks</a></tt><tt class="py-op">(</tt><tt class="py-string">"modbus_tcp.TcpServer.before_send"</tt><tt class="py-op">,</tt> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-name">sock</tt><tt class="py-op">,</tt> <tt class="py-name">response</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L330"></a><tt class="py-lineno">330</tt>  <tt class="py-line">                                <tt class="py-keyword">if</tt> <tt class="py-name">retval</tt> <tt class="py-op">&lt;&gt;</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L331"></a><tt class="py-lineno">331</tt>  <tt class="py-line">                                    <tt class="py-name">response</tt> <tt class="py-op">=</tt> <tt class="py-name">retval</tt> </tt>
<a name="L332"></a><tt class="py-lineno">332</tt>  <tt class="py-line">                                <tt class="py-name">sock</tt><tt class="py-op">.</tt><tt class="py-name">send</tt><tt class="py-op">(</tt><tt class="py-name">response</tt><tt class="py-op">)</tt> </tt>
<a name="L333"></a><tt class="py-lineno">333</tt>  <tt class="py-line">                            <tt class="py-keyword">except</tt> <tt class="py-name">Exception</tt><tt class="py-op">,</tt> <tt class="py-name">msg</tt><tt class="py-op">:</tt> </tt>
<a name="L334"></a><tt class="py-lineno">334</tt>  <tt class="py-line">                                <tt class="py-name">is_ok</tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt>
<a name="L335"></a><tt class="py-lineno">335</tt>  <tt class="py-line">                                <tt id="link-75" class="py-name"><a title="modbus_tk.modbus.LOGGER
modbus_tk.modbus_rtu.LOGGER
modbus_tk.modbus_tcp.LOGGER
modbus_tk.simulator.LOGGER" class="py-name" href="#" onclick="return doclink('link-75', 'LOGGER', 'link-51');">LOGGER</a></tt><tt class="py-op">.</tt><tt class="py-name">error</tt><tt class="py-op">(</tt><tt class="py-string">"Error while sending on socket %d, Exception occurred: %s"</tt><tt class="py-op">,</tt> \ </tt>
<a name="L336"></a><tt class="py-lineno">336</tt>  <tt class="py-line">                                             <tt class="py-name">sock</tt><tt class="py-op">.</tt><tt class="py-name">fileno</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">msg</tt><tt class="py-op">)</tt> </tt>
<a name="L337"></a><tt class="py-lineno">337</tt>  <tt class="py-line">            <tt class="py-keyword">except</tt> <tt class="py-name">Exception</tt><tt class="py-op">,</tt> <tt class="py-name">excpt</tt><tt class="py-op">:</tt> </tt>
<a name="L338"></a><tt class="py-lineno">338</tt>  <tt class="py-line">                <tt id="link-76" class="py-name"><a title="modbus_tk.modbus.LOGGER
modbus_tk.modbus_rtu.LOGGER
modbus_tk.modbus_tcp.LOGGER
modbus_tk.simulator.LOGGER" class="py-name" href="#" onclick="return doclink('link-76', 'LOGGER', 'link-51');">LOGGER</a></tt><tt class="py-op">.</tt><tt class="py-name">warning</tt><tt class="py-op">(</tt><tt class="py-string">"Error while processing data on socket %d: %s"</tt><tt class="py-op">,</tt> <tt class="py-name">sock</tt><tt class="py-op">.</tt><tt class="py-name">fileno</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">excpt</tt><tt class="py-op">)</tt> </tt>
<a name="L339"></a><tt class="py-lineno">339</tt>  <tt class="py-line">                <tt id="link-77" class="py-name"><a title="modbus_tk.hooks.call_hooks" class="py-name" href="#" onclick="return doclink('link-77', 'call_hooks', 'link-2');">call_hooks</a></tt><tt class="py-op">(</tt><tt class="py-string">"modbus_tcp.TcpServer.on_error"</tt><tt class="py-op">,</tt> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-name">sock</tt><tt class="py-op">,</tt> <tt class="py-name">excpt</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L340"></a><tt class="py-lineno">340</tt>  <tt class="py-line">                <tt class="py-name">sock</tt><tt class="py-op">.</tt><tt id="link-78" class="py-name"><a title="modbus_tk.modbus.Master.close
modbus_tk.modbus_rtu.RtuServer.close
modbus_tk.simulator.ConsoleInterface.close
modbus_tk.simulator.RpcInterface.close
modbus_tk.simulator.Simulator.close" class="py-name" href="#" onclick="return doclink('link-78', 'close', 'link-38');">close</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L341"></a><tt class="py-lineno">341</tt>  <tt class="py-line">                <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_sockets</tt><tt class="py-op">.</tt><tt class="py-name">remove</tt><tt class="py-op">(</tt><tt class="py-name">sock</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L342"></a><tt class="py-lineno">342</tt>  <tt class="py-line"> </tt><script type="text/javascript">
<!--
expandto(location.href);
// -->
</script>
</pre>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://code.google.com/p/modbus-tk/">Modbus Test Kit</a></th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Wed May 26 17:43:07 2010
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
